Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Lint package.json requirements with eslint-plugin-json-files

See original GitHub issue

With @kellyselden’s PR here: https://github.com/kellyselden/eslint-plugin-json-files

I think it now makes sense to add some very important, yet presently missing lints for:

package.json
- for all addons
  - keywords must have ember-addon
- v2 addons
  - require an addon-main entry and the file must exist
  - ember-addon (or ember) entry must exist
    - version must be set to 2
    - addon-main must be present in exports
    - app-js is optional, but must point at files present in the exports
  - a the output / dist folder must include at least one entry in exports (name of dist should be configurable)
  - if a v2 addon is “browser-only”, we don’t need an engines entry
  - forbid dependencies (things common in v1 addons)
    - ember-cli-htmlbars
    - ember-cli-babel
  - recommend peerDependencies (+ devDeps):
    - ember-source

Issue Analytics

State:
Created 9 months ago
Comments:8 (8 by maintainers)

Top GitHub Comments

1reaction

bmishcommented, Dec 30, 2022

The ember-cli blueprint already includes various JavaScript linters including eslint-plugin-ember, handlebars linting via ember-template-lint, and there’s a proposal to add stylelint. I’m not sure why package.json linting necessarily belongs in the Ember-JavaScript-focused linting package. Just to suggest an alternative, package.json linting might deserve to be an additional type of linting added to the ember-cli blueprint, once there’s a stable and worthwhile package available for that.

0reactions

NullVoxPopulicommented, Dec 30, 2022

I started a thread in discord, if you want to help work out some details 😅