neostandard

Table of Contents

• Quick Start
  • Migrate from standard
  • Add to new project
• Configuration options
• Extending
• Additional exports
  • resolveIgnoresFromGitignore()
  • Exported plugins
    • List of exported plugins
    • Usage of exported plugin
• Missing for 1.0.0 release
• Differences to standard / eslint-config-standard 17.x
  • Relaxed rules
• Config helper
  • Config migration
• Readme badges
• Mission statement
  • Rule guidelines
• Governance
• Used by

Quick Start

Migrate from standard

1. npm install -D neostandard eslint
2. (Validate that it runs cleanly by running npx neostandard --help, see #267)
3. npx neostandard --migrate > eslint.config.js (uses our config helper)
4. Replace standard with eslint in all places where you run standard, eg. "scripts" and .github/workflows/ (neostandard CLI tracked in #2)
5. (Add ESLint editor integration, eg. VS Code ESLint extension)
6. Cleanup:
   • npm uninstall standard
   • Remove unused "standard" top level key from your package.json
   • Deactivate standard specific integrations if you no longer use them (eg. vscode-standard))

Add to new project

1. npm install -D neostandard eslint

2. Add an eslint.config.js:

   Using config helper:

   npx neostandard --esm > eslint.config.js

   Or to get CommonJS:

   npx neostandard > eslint.config.js

   Or manually create the file as ESM:

   import neostandard from 'neostandard'
   
   export default neostandard({
     // options
   })

   Or as CommonJS:

   module.exports = require('neostandard')({
     // options
   })

3. Run neostandard by running ESLint, eg. using npx eslint, npx eslint --fix or similar

Configuration options

All examples below use ESM (ECMAScript Modules) syntax. If you're using CommonJS (CJS), replace the import/export statements with the following:

// Replace
import neostandard from 'neostandard'
export default neostandard({ /* options */ })

// With
const neostandard = require('neostandard')
module.exports = neostandard({ /* options */ })

Here's a basic example of how to configure neostandard:

import neostandard from 'neostandard'

export default neostandard({
  ts: true,  // an option
  // Add other options here
})

The options below allow you to customize neostandard for your project. Use them to add global variables, ignore files, enable TypeScript support, and more.

• env - string[] - adds additional globals by importing them from the globals npm module

  import neostandard from 'neostandard'
  
  export default neostandard({
    env: ['browser', 'mocha'],  // Add browser and mocha global variables
  })

• files - string[] - additional file patterns to match. Uses the same shape as ESLint files

  import neostandard from 'neostandard'
  
  export default neostandard({
    files: ['src/**/*.js', 'tests/**/*.js'],  // Lint only files in src/ and tests/ directories
  })

• filesTs - string[] - additional file patterns for the TypeScript configs to match. Uses the same shape as ESLint files

  import neostandard from 'neostandard'
  
  export default neostandard({
    ts: true,   // Enable TypeScript support
    filesTs: ['src/**/*.ts', 'tests/**/*.ts'],  // Lint only TypeScript files in src/ and tests/ directories
  })

• globals - string[] | object - an array of names of globals or an object of the same shape as ESLint languageOptions.globals

  Using an array:

  import neostandard from 'neostandard'
  
  export default neostandard({
    globals: ['
  Using an object:
  import neostandard from 'neostandard'
  
  export default neostandard({
    globals: {
      $: 'readonly',  // $ is a read-only global
      jQuery: 'writable',  // jQuery can be modified
      localStorage: 'off',  // Disable the localStorage global
    },
  })
  

• ignores - string[] - an array of glob patterns for files that the config should not apply to, see ESLint documentation for details

  import neostandard from 'neostandard'
  
  export default neostandard({
    ignores: ['dist/**/*', 'tests/**'],  // Ignore files in dist/ and tests/ directories
  })

• noJsx - boolean - if set, no jsx rules will be added. Useful if for some reason its clashing with your use of JSX-style syntax

  import neostandard from 'neostandard'
  
  export default neostandard({
    noJsx: true,  // Disable JSX-specific rules
  })

• noStyle - boolean - if set, no style rules will be added. Especially useful when combined with Prettier, dprint or similar

  import neostandard from 'neostandard'
  
  export default neostandard({
    noStyle: true,  // Disable style-related rules (useful with Prettier or dprint)
  })

• semi - boolean - if set, enforce rather than forbid semicolons (same as semistandard did)

  import neostandard from 'neostandard'
  
  export default neostandard({
    semi: true,  // Enforce semicolons (like semistandard)
  })

• ts - boolean - if set, TypeScript syntax will be supported and *.ts (including *.d.ts) will be checked. To add additional file patterns to the TypeScript checks, use filesTs

  import neostandard from 'neostandard'
  
  export default neostandard({
    ts: true,  // Enable TypeScript support and lint .ts files
  })

import neostandard from 'neostandard'
import jsdoc from 'eslint-plugin-jsdoc';

export default [
  ...neostandard(),
  jsdoc.configs['flat/recommended-typescript-flavor'],
]

import neostandard from 'neostandard'
import importX from 'eslint-plugin-import-x'

export default [
  ...neostandard(),
  {
    plugins: {
      'import-x': importX
    },
    rules: {
      'import-x/export': 'error',
      'import-x/first': 'error',
      'import-x/no-absolute-path': ['error', { esmodule: true, commonjs: true, amd: false }],
      'import-x/no-duplicates': 'error',
      'import-x/no-named-default': 'error',
      'import-x/no-webpack-loader-syntax': 'error',
    }
  }
]

import neostandard from 'neostandard'
import importX from 'eslint-plugin-import-x'
import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'

export default [
  ...neostandard(),
  {
    plugins: {
      'import-x': importX
    },
    settings: {
      'import-x/resolver-next': [
        createTypeScriptImportResolver({
          project: './tsconfig.json'
        })
      ]
    },
    rules: {
      'import-x/export': 'error',
      'import-x/first': 'error',
      'import-x/no-absolute-path': ['error', { esmodule: true, commonjs: true, amd: false }],
      'import-x/no-duplicates': 'error',
      'import-x/no-named-default': 'error',
      'import-x/no-webpack-loader-syntax': 'error',
    }
  }
]

tsc --noEmit

import neostandard, { resolveIgnoresFromGitignore } from 'neostandard'

export default neostandard({
  ignores: resolveIgnoresFromGitignore(),
})

module.exports = require('neostandard')({
  ignores: require('neostandard').resolveIgnoresFromGitignore(),
})

import neostandard, { plugins } from 'neostandard'

export default [
  ...neostandard(),
  plugins.n.configs['flat/recommended'],
]

neostandard --semi --ts > eslint.config.js

neostandard --help

neostandard --migrate > eslint.config.js

neostandard --semi --migrate > eslint.config.js

[![neostandard javascript style](https://img.shields.io/badge/neo-standard-7fffff?style=flat&labelColor=ff80ff)](https://github.com/neostandard/neostandard)

[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-7fffff?style=flat&labelColor=ff80ff)](https://github.com/neostandard/neostandard)

[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

Using an object:

Extending

The __INLINE_CODE_50__ function returns an ESLint config array which is intended to be exported directly or, if you want to modify or extend the config, can be combined with other configs like any other ESLint config array:

Do note that __INLINE_CODE_51__ is intended to be a complete linting config in itself, only extend it if you have needs that goes beyond what __INLINE_CODE_52__ provides, and open an issue if you believe __INLINE_CODE_53__ itself should be extended or changed in that direction.

It's recommended to stay compatible with the plain config when extending and only make your config stricter, not relax any of the rules, as your project would then still pass when using just the plain __INLINE_CODE_54__-config, which helps people know what baseline to expect from your project.

Adding back import checking

As of neostandard v1.0.0, __INLINE_CODE_55__ has been removed to reduce dependency weight and installation complexity. For most projects, TypeScript's compiler (__INLINE_CODE_56__) provides superior import/export checking with full project context.

If you still need ESLint-based import checking, you can add it back manually:

For TypeScript projects, you may also want to add the TypeScript resolver:

Recommended alternative: Use TypeScript's compiler for import checking instead:

This provides more comprehensive checking including type imports, module resolution, and cross-file validation.

Additional exports

resolveIgnoresFromGitignore()

Finds a __INLINE_CODE_57__ file that resides in the same directory as the ESLint config file and returns an array of ESLint ignores that matches the same files.

ESM:

CommonJS:

Exported plugins

__INLINE_CODE_58__ exports all the ESLint plugins that it uses. This to ensure that users who need to reference the plugin themselves will use the exact same instance of the plugin, which is a necessity when a plugin prefix is defined in multiple places.

List of exported plugins

• __INLINE_CODE_59__ - export of __INLINE_CODE_60__
• __INLINE_CODE_61__ - export of __INLINE_CODE_62__
• __INLINE_CODE_63__ - export of __INLINE_CODE_64__
• __INLINE_CODE_65__ - export of __INLINE_CODE_66__
• __INLINE_CODE_67__ - export of __INLINE_CODE_68__

Usage of exported plugin

If one eg. wants to add the __INLINE_CODE_69__ recommended config, then one can do:

Missing for 1.0.0 release

• Investigate a dedicated __INLINE_CODE_70__ runner: #33 / #2

Full list in 1.0.0 milestone

Differences to standard / eslint-config-standard 17.x

• Open governance, resolving governance issue
• Built for ESLint 9
• Relies on ESLint flat config to bundle plugins rather than custom __INLINE_CODE_71__
• Replaces deprecated ESLint style rules with __INLINE_CODE_72__ rules
• Defaults to the __INLINE_CODE_73__ behaviour of bundling JSX-support (ported from __INLINE_CODE_74__) with a __INLINE_CODE_75__ option that deactivates it to match __INLINE_CODE_76__
• Built in options replaces need for separate modules
  • __INLINE_CODE_77__ option makes __INLINE_CODE_78__ files be checked as well (used to be handled by __INLINE_CODE_79__)
  • __INLINE_CODE_80__ option enforces rather than ban semicolons (used to be handled by __INLINE_CODE_81__)
  • __INLINE_CODE_82__ option deactivates style rules (used to require something like __INLINE_CODE_83__)

Relaxed rules

• __INLINE_CODE_84__ – changed – set to ignore dangling commas in arrays, objects, imports, exports and is it set to __INLINE_CODE_85__ rather than __INLINE_CODE_86__
• __INLINE_CODE_87__ – changed – sets __INLINE_CODE_88__ to __INLINE_CODE_89__, useful for aligning comments across multiple line
• __INLINE_CODE_90__ – deactivated – clashes with the __INLINE_CODE_91__ check in TypeScript
• __INLINE_CODE_92__ – changed – changed to __INLINE_CODE_93__ instead of __INLINE_CODE_94__ as they are not urgent to fix

Config helper

You can use the provided CLI tool to generate a config for you:

To see all available flags, run:

Config migration

The CLI tool can also migrate an existing __INLINE_CODE_95__ configuration from __INLINE_CODE_96__:

Migrations can also be extended, so to eg. migrate a __INLINE_CODE_97__ setup, do:

Readme badges

Yes! If you use __INLINE_CODE_98__ in your project, you can include one of these badges in your readme to let people know that your code is using the neostandard style.

Mission statement

Prior to the __INLINE_CODE_99__ release we are still rapidly evolving with fixes and improvements to reach rule parity with __INLINE_CODE_100__, hence more breaking changes will be experienced until then, as well as evolution of this statement

__INLINE_CODE_101__ intends to set an expectable baseline for project linting that's descriptive of best practices rather than prescriptive of any opinionated approach.

Rule guidelines

1. __INLINE_CODE_102__ rules describes current best practices in the community and help align developers, contributors and maintainers along those
2. __INLINE_CODE_103__ rules are not a tool to promote changed practices within the community by prescribing new such practices
3. __INLINE_CODE_104__ rule changes and additions should be aligned with projects prior to being released, by eg. sending PR:s to them to align them ahead of time. When new best practices are incompatible with current best practices, rules should first be relaxed to allow for both approaches, then be made stricter when the community has moved to the new approach
4. __INLINE_CODE_105__ rule changes and additions should improve the description of project best practices, not prescribe new practices
5. __INLINE_CODE_106__ should, when faced with no clear best practice, avoid adding such a rule as it risks becoming prescriptive rather than descriptive. If leaving out such a rule would make __INLINE_CODE_107__ an incomplete baseline config, and the community is split between a few clear alternatives (such as __INLINE_CODE_108__), then making it configurable can enable it to still be added, but that should only be done in exceptional cases

Governance

__INLINE_CODE_109__ is a community project with open governance.

See GOVERNANCE.md for specifics.

Used by

A subset of some of the projects that rely on __INLINE_CODE_110__:

• __INLINE_CODE_111__ (https://github.com/bcomnes/npm-run-all2/pull/142)
• __INLINE_CODE_112__ (https://github.com/fastify/fastify/pull/5509)
• __INLINE_CODE_113__ (https://github.com/nodejs/undici/pull/3485)
• __INLINE_CODE_114__
• __INLINE_CODE_115__ (https://github.com/uuidjs/uuid/pull/752)