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

Add repository.directory field to package.json #268

Closed
4 tasks done
ybiquitous opened this issue Aug 15, 2021 · 3 comments · Fixed by #269
Closed
4 tasks done

Add repository.directory field to package.json #268

ybiquitous opened this issue Aug 15, 2021 · 3 comments · Fixed by #269
Labels
🏗 area/tools This affects tooling 💪 phase/solved Post is done 🐢 platform/node This affects Node 👶 semver/patch This is a backwards-compatible fix 🦋 type/enhancement This is great to have

Comments

@ybiquitous
Copy link
Contributor

Initial checklist

Problem

I executed the npm repo remark-lint command on my terminal, but https://github.com/remarkjs/remark-lint/tree/main opens unexpectedly on my browser, instead of https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint.

I think it useful to open https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint, like @babel-core.
For example, when executing npm repo @babel-core, https://github.com/babel/babel/tree/master/packages/babel-core opens.

We can say that to other packages in this mono repo, like unified-lint-rule.

See also:

Solution

What about adding the repository.directory field to package.json of all the published packages, like @babel/core?

For example:

"repository": "https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint",

-  "repository": "https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remarkjs/remark-lint.git",
+    "directory": "packages/remark-lint"
+  }

See also:

Alternatives

I don't have any alternatives.

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Aug 15, 2021
@ChristianMurphy ChristianMurphy added 🏗 area/tools This affects tooling 🐢 platform/node This affects Node 👶 semver/patch This is a backwards-compatible fix 🦋 type/enhancement This is great to have labels Aug 16, 2021
@ChristianMurphy
Copy link
Member

Sounds like a good add, would you be interested in opening a PR adding the metadata to packages @ybiquitous?

@ybiquitous
Copy link
Contributor Author

Yes, I'll open a PR today later.

wooorm pushed a commit that referenced this issue Aug 16, 2021
This change updates the `repository` field in all `package.json`s to add a `directory`.
This also modifies the scripts to get the repository URLs.

Closes GH-268.
Closes GH-269.

Reviewed-by: Titus Wormer <[email protected]>
@github-actions

This comment has been minimized.

@wooorm wooorm added the 💪 phase/solved Post is done label Aug 16, 2021
@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Aug 16, 2021
simnalamburt pushed a commit to simnalamburt/remark-lint that referenced this issue Mar 19, 2024
This change updates the `repository` field in all `package.json`s to add a `directory`.
This also modifies the scripts to get the repository URLs.

Closes remarkjsGH-268.
Closes remarkjsGH-269.

Reviewed-by: Titus Wormer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏗 area/tools This affects tooling 💪 phase/solved Post is done 🐢 platform/node This affects Node 👶 semver/patch This is a backwards-compatible fix 🦋 type/enhancement This is great to have
Development

Successfully merging a pull request may close this issue.

3 participants