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

Rename metadata.json to config.json #493

Closed
simonw opened this issue May 29, 2019 · 7 comments
Closed

Rename metadata.json to config.json #493

simonw opened this issue May 29, 2019 · 7 comments

Comments

@simonw
Copy link
Owner

simonw commented May 29, 2019

It is increasingly being useful configuration options, when it started out as purely metadata.

Could cause confusion with the --config mechanism though - maybe that should be called "settings" instead?

@simonw
Copy link
Owner Author

simonw commented Dec 16, 2019

This is particularly relevant as plugins increasingly use metadata.json for their plugin configuration: https://datasette.readthedocs.io/en/0.32/plugins.html#plugin-configuration

@simonw simonw added this to the Datasette 1.0 milestone Dec 16, 2019
@simonw simonw changed the title Consider renaming metadata.json to config.json Rename metadata.json to config.json Jun 8, 2020
@simonw
Copy link
Owner Author

simonw commented Jun 8, 2020

I'm definitely doing this rename, now that metadata.json is used for allow permissions configuration as well as-of #811.

@simonw
Copy link
Owner Author

simonw commented Jun 8, 2020

I'll also rename --config to --setting.

@jefftriplett
Copy link
Contributor

I was confused by --config and I tried passing the json from datasette-ripgrep into config.json just as a wild guess.

A short term solution might be pointing out in plugins that their snippet json can go in metadata.json at least makes it easier to search for config options or to know where to start if someone is new.

@simonw
Copy link
Owner Author

simonw commented Dec 18, 2020

Is there any reason to keep --setting rather than moving those items into a configure.json file with all the configuration options that currently live in metadata.json?

@jefftriplett
Copy link
Contributor

I can't keep up with the renaming contexts, but I like having the ability to run datasette+ datasette-ripgrep against different configs:

datasette serve --metadata=./metadata.json

I have one for all of my code and one per client who has lots of code. So as long as I can point to datasette to something, it's easy to work with.

simonw pushed a commit that referenced this issue Aug 23, 2023
The first step in defining the new `datasette.json/yaml` configuration mechanism.

Refs #2093, #2143, #493
@simonw
Copy link
Owner Author

simonw commented Aug 23, 2023

It's going to be called datasette.json and the concept of metadata will be split out separately. See:

@simonw simonw closed this as completed Aug 23, 2023
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

2 participants