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

project config location and lookup process #17

Open
dherman opened this issue May 31, 2018 · 2 comments
Open

project config location and lookup process #17

dherman opened this issue May 31, 2018 · 2 comments

Comments

@dherman
Copy link
Contributor

dherman commented May 31, 2018

It's come up in some discussions that we might want to consider putting Notion config information in a separate config file (e.g. my_project/.notionrc or maybe my_project/.config/notion/config), and nudge projects towards putting that file in their .npmignore, possibly by automating the workflow of configuring Notion through notion commands, like notion init.

I'll try to capture the constraints in this comment (and edit them if/when we identify more in discussion).

Constraints

  • Should libraries' config go into the npm registry?
  • What should the mental model be when you cd into my_project/node_modules/some_dependency?
  • What is the adoption overhead of the config strategy?
  • What behavior makes sense in large monorepos?
@dherman
Copy link
Contributor Author

dherman commented May 31, 2018

I want to start with a suggestion that we don't make this change, for the following reasons:

  • I think there's a good case to be made the libraries do want their config to go in the npm registry, so e.g. when you cd into my_project/node_modules/some_dependency you can call that dependency's commands and get the right versions of the toolchain.
  • I think it's easier for developers to have a mental model that's a simple walk up the filesystem, just like the require/package.json resolution process.
  • It's lower project overhead to add a key to package.json than add a separate file.

I think there's time to experiment with package.json and see how it interacts with dependencies, and see if we learn what problem cases it has if any.

@dherman
Copy link
Contributor Author

dherman commented May 31, 2018

Ah, another constraint to be sure we think about is large monorepos.

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

No branches or pull requests

1 participant