refactor(extractor/babel)!: sealed, non-fragile babel extractor options

[timofei-iatsenko]

Fixes:

#1314
#1305
#1206
#952

All current problems with babel extractor due to the fact user may have various babel configuration and transformation which potentially may break extraction process (and they do!)

Briefly:

1. Extractor should not be affected by any of the babel plugins / preset user may or may not use on the project (hello nextjs with SWC!)
2. Extractor should successfully parse files as long as it is valid ECMA syntax (up to stage3), with exceptions to typescript and flow
3. Extractor should be self-contained, user should not install additional packages to parse a valid ECMAScript code
4. Extractor should not transform code, only analyze. This brings speed for process and resolve issues when AST after transforming become not parsable by extractor

Supported projects:

• Typescript / TSX -> supported out of the box, by matching a file extension
• JS / JSX -> supported out of the box
• Flow -> supported by enabling extractorParserOptions.flow: true
• Custom projects with unsupported syntax, stage0 / stage1 proposals, vue, etc -> supported via custom extractor

Custom extractor interface was changed to supply code and sourcemaps, so simple custom extractor may look like:

import babel from "@lingui/cli/api/extractors/babel"

const extractor: ExtractorType = {
  match(filename: string) {
      return filename.endsWith(".custom");
  }

  extract(filename: string, code: string, onMessageExtracted) {
     const {code, sourcemaps} = transformMyCustomFileToJs(filename, code);

     // reuse extractor from cli
     return babel(filename, code, onMessageExtracted, {sourcemaps})
  }
}

BREAKING CHANGES:

• @lingui/cli/api/extractors/typescript extractor was removed and should be deleted from lingui.config
• extractorBabelOptions - was removed fron lingui config and no longer supported (todo: write a deperecation warning in configuration validation) and should be removed
• Public interface of ExtractorType is changed

Tasks:

• Update docs
  • Flow Setup
  • Describe settings
  • How to create a custom extractor
• Add warning in validators for lingui config when extractorBabelOptions passed

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
js-lingui	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 14, 2023 at 1:58PM (UTC)

[github-actions]

size-limit report 📦

Path	Size
./packages/core/build/esm/index.js	1.76 KB (0%)
./packages/detect-locale/build/esm/index.js	812 B (0%)
./packages/react/build/esm/index.js	1.79 KB (0%)
./packages/remote-loader/build/esm/index.js	7.29 KB (0%)

[andrii-bodnar]

@thekip anyway thanks for your contributions, but could you please do it in smaller reviewable parts? Such PRs are extremely hard to review and there is a big risk to miss some bugs

also, please do not push so hard with these major changes, rewriting the library it's something that we don't want at the moment. Please, let's do all of this work in smaller steps

[timofei-iatsenko]

but could you please do it in smaller reviewable parts?

No, i could not. This already an atomic change to only one part of functionality. Please review only this commit 5c162c2

The major changes concentrated around one file @lingui/cli/api/extractors/babel rest is tests updates or some fixes to make it work.

[timofei-iatsenko]

done