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

Allowing scoped package name for shareable configs #327

Open
jpapini opened this issue Jan 29, 2022 · 5 comments
Open

Allowing scoped package name for shareable configs #327

jpapini opened this issue Jan 29, 2022 · 5 comments

Comments

@jpapini
Copy link

jpapini commented Jan 29, 2022

According to the doc, shareable configs can only be named with the solhint-config- prefix.
These lines confirms this rule:

const configGetter = path => {
let extensionPath = null
if (path.startsWith('solhint:')) {
extensionPath = getSolhintCoreConfigPath(path)
} else {
// Load packages with rules
extensionPath = `solhint-config-${path}`
}
const extensionConfig = require(extensionPath)
return extensionConfig
}

But I think we should allow users to name their packages with a scope like ESLint (doc).

For example:
@scope/solhint-config or @scope/solhint-config-myconfig.

This would support packages that are hosted on private repos like GitHub or Package Cloud.

@johnnyshankman
Copy link

johnnyshankman commented Jul 20, 2023

Bump, this is a blocker for me atm. My private organization cannot use the extension system as we need our pkg to be private and scoped.

@johnnyshankman
Copy link

johnnyshankman commented Jul 20, 2023

@dbale-altoros dbale-altoros added the awaiting user feedback awaiting user feedback label Aug 10, 2023
@dbale-altoros
Copy link
Collaborator

@johnnyshankman @jpapini
Sorry for the late response.
There is a new release available and we will be updating solhint on regular basis with a dedicated team to it
Thanks for posting

I'm not sure I understand this issue, can you elaborate ?
Thanks!

@johnnyshankman
Copy link

johnnyshankman commented Aug 11, 2023

@dbale-altoros so right here:
https://github.com/protofire/solhint/blob/master/lib/config/config-file.js#L68

you expect the npm package name to start with solhint-config- which means it can never be a privately scoped package on npm, as those always begin with @somecompany/the-pkg-name

example is that i want to deploy something like @manifoldxyz/solhint-config-default for my company.

example from npm docs:
https://docs.npmjs.com/creating-and-publishing-private-packages
image

@dbale-altoros
Copy link
Collaborator

Ok, thanks for the clarification
I understand the issue
I'm not sure about the impact of changing that... we need time to review this

Thanks a lot for posting!

@dbale-altoros dbale-altoros added config addition and removed awaiting user feedback awaiting user feedback labels Aug 11, 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

3 participants