Interpret paths relative to config file instead of cwd #237
Conversation
aomarks
changed the title
| resolveBareModules: undefined, | ||
| benchmarks: [ | ||
| { | ||
| name: '/mylib/mybench/index.html', |
There was a problem hiding this comment.
Great! The only other place to maybe put a small hint of the usage of root is in the CLI docs: https://github.com/Polymer/tachometer#config-file:~:text=Show%20documentation-,%2D%2Droot,-./
The new changes only apply to the JSON configs, and when you're using a JSON config the |
Side note, in general the config file options aren't really properly documented, the README needs a revamp to make this all more clear. But not tackling that right now. |
This PR removes Lerna entirely. Now we just use npm workspaces + wireit. ### Benefits - No more `npm run bootstrap`, just `npm ci`. - To upgrade or add a dependency, edit the `package.json` and `npm i` from the root. - Cuts around 30s off install time in CI. - Only one `package-lock.json` file for the whole monorepo. ### Tricky parts - npm workspaces hoists packages to the top-level `node_modules/` folder whenever possible. This is different to Lerna, which always put all the dependencies in each package's own `node_modules/` folder. Only if there is a conflicting version would there now be a `node_modules/` folder inside a workspace package. - This required updating various paths to reach further up the file system. - In a couple of cases, this caused issues with conflicting `@types` packages for TypeScript, because while previously only the local version was available, now multiple versions could be. This is because TypeScript by default ambiently loads all `node_modules/@types/*` packages from _all recursive parent directories_. The solution to these cases are to specify that only the immediate `node_modules/` folder should be consulted through the `typeRoots` setting. - This required changing the tachometer server root directory as well, which ended up being more complicated than it should be, because of the way tachometer was treating paths in config files as relative to the current working directory, instead of the config file path. In google/tachometer#237 I changed that behavior, so this also bumps the tachometer version and updates the configs accordingly. Fixes #3093
| "root": "../..", | ||
| "benchmarks": [ | ||
| { | ||
| "url": "foo.html" |
There was a problem hiding this comment.
[no action needed]. Ooops I missed leaving this comment. Sorry! I realized the bottom example doesn't match the top one. It doesn't have to match, however should the url match in the second example - to show an easy way to migrate using the root?
This second example currently resolves to <repo>/foo.html.
Expected the second example to be:
{
"root": "../..",
"benchmarks": [
{
"url": "benchmarks/foo/index.html"
}
]
}
Previously, the server root and the benchmark paths were interpreted relative to the current working directory. This meant that a given config could only ever run from one specific working directory, which was confusing and inconvenient. Now, they are interpreted relative to the config file path itself, so the current directory doesn't matter.
Also:
Fixes #176