Export eslint config for use in other client apps

Police-Data-Accessibility-Project / design-system

Vue component library and assets for PDAP-branded client apps

MIT License

0 stars 0 forks source link

Export eslint config for use in other client apps #40

Closed joshuagraber closed 5 months ago

joshuagraber commented 6 months ago

Follow the pattern established the /config directory, from which we currently export the TailwindCSS config.

The design-system config itself is designed for typescript, so this will be a two-part project.

[x] Create an eslint-config directory and create a sub-package @pdap-design-system/eslint-config.
[x] Export the base config from this package. This will bundle the config as a part of the package, for use in other projects.
[x] In the root directory, update eslintrc.json -> eslintrc.cjs and extend the base config from @pdap-design-system/eslint-config.
[x] Update the README to ensure ease of use.

Kenny4297 commented 5 months ago

Hi @joshuagraber, I believe that I can help with this issue. Would you mind assigning me to it?

joshuagraber commented 5 months ago

I believe that I can help with this issue. Would you mind assigning me to it?

Hey @Kenny4297, thank you for reaching out! I started work on this yesterday, and I've got a draft PR open here. Would you want to have a look and review my work, make any suggestions for changes, and update the README?

The lint step on this PR will fail, because we haven't published the config package to npm yet, but I'll publish once we've got the changes squared away, before we merge to main.

Kenny4297 commented 5 months ago

Hi @joshuagraber. Your code looks good! A few clarification questions:

1) Did you end up updating the eslintrc.json to eslintrc.js? I don't see this change in your current PR; am I missing something?

2) When I update the README, do you want me to assume / include that you have in fact published the the config package to npm?

Any assistance would be helpful!

joshuagraber commented 5 months ago

Hey, @Kenny4297 thank you for the clarifying questions here.

Yes, but eslint was complaining that it wasn't able to import it via dynamic require (perhaps they went cjs-only in version 8? I haven't had the chance to look into it), so I renamed to eslintrc.cjs to allow for the commonjs methods that eslint is expecting. The file is here. I've updated the issue description to match.
Yes, please! in eslint-config/package.json, you'll see that the "name" value is "@pdap-design-system/eslint-config. This will be extendable using the same string, once published (and we will publish before we merge this PR). So, TLDR: yes.

And then, if you are interested in picking up any other issues, this one is related and may be a good next step.

github-actions[bot] commented 5 months ago

:tada: This issue has been resolved in version 2.2.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: