Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Missing documentation on configuration #1063

Open
Huy-Ngo opened this issue Jan 31, 2024 · 2 comments
Open

doc: Missing documentation on configuration #1063

Huy-Ngo opened this issue Jan 31, 2024 · 2 comments

Comments

@Huy-Ngo
Copy link

Huy-Ngo commented Jan 31, 2024

Overview Description

The page https://babel.pocoo.org/en/latest/messages.html has description of configuration format, however it does not mention the configuration file name anywhere, nor does any other pages.

The current description is also vague on which configuration options and which extractors are supported by default.

Expected Results

The documentation has details of info above.

@akx
Copy link
Member

akx commented Jan 31, 2024

There is no single configuration filename; you'd use

  -F MAPPING_FILE, --mapping-file=MAPPING_FILE, --mapping=MAPPING_FILE
                        path to the mapping configuration file

to specify one when running a Babel CLI command. This is (admittedly vaguely) documented over at https://babel.pocoo.org/en/latest/setup.html#method-mapping (which is linked to from the page you mention).

Improvement PRs are welcome!

@tomasr8
Copy link
Member

tomasr8 commented Aug 17, 2024

Just putting it here, we should also add documentation for the new TOML config: #1108

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants