Style Lint JS

Installs and configure default linter and style checker for javascript and/or typescript projects.

• Install
• Additional Rules or Override

Using ESLint and Prettier with default rules:

• ESLint rules:
  • For javascript
  • For Typescript
• Prettier rules

Install

To generate default config files in your project, run

npx style-lint-js init

# OR for typescript projects

npx style-lint-js init-ts

This creates an eslint.config.js and .prettierrc.js in your project. Once installed, you can run eslint or prettier commands as normal ie npx eslint file-to-lint.js or add to your package.json script.

Note: When initialising for typescript projects, you will need to have typescript installed already in your project for the typescript eslint rules to work.

Additional Rules or Override

Update eslint.config.js to add or override default rules by appending a new config object to the array.

ie

import config from 'style-lint-js/eslint.config.js';

export default [
  ...config,
  {
    rules: {
      'import/newline-after-import': 'error',
    },
  },
];

For typescript projects:

import config from 'style-lint-js/eslint.config-ts.js';

export default [
  ...config,
  {
    files: ['**/*.ts'],
    rules: {
      '@typescript-eslint/explicit-function-return-type': 'error',
    },
  },
];

To ignore additional paths, add an ignores config object:

import config from 'style-lint-js/eslint.config.js';

export default [
  ...config,
  {
    ignores: ['generated/**', 'vendor/**'],
  },
];