Skip to content

Repository files navigation

eslint-config-volebo

########################################################################
#                                                                      #
# db   db  .888.  dP    88888b 888ba   .888.     d8b  db 88888b d8888P #
# 88   88 d8' `8b 88    88     88 `8b d8' `8b    88V8 88 88       88   #
# Y8   8P 88   88 88    88aa   88a8P' 88   88    88 VL88 88aa     88   #
# `8b d8' 88   88 88    88     88 `8b 88   88    88  V88 88       88   #
#  `8V8'  Y8. .8P 88    88     88 .88 Y8. .8P dP 88  `88 88       88   #
#   `Y'    `88P'  8888P 88888P 88888'  `88P'  88 VP   8P 88888P   dP   #
#                                                                      #
########################################################################

npm version Build Status npm downloads Socket Badge Known Vulnerabilities

Common style guide for all Volebo.Net projects

Install

npm install --save-dev eslint-config-volebo eslint

Then create an eslint.config.js file in the root of your project:

import volebo from 'eslint-config-volebo'

export default [
	...volebo,
]

Or providing more settings (most of them inherited from neostandard)

import { eslintConfigVolebo } from 'eslint-config-volebo'
import jsdoc from 'eslint-plugin-jsdoc'

export default [
	...eslintConfigVolebo({
		// options
		globals: {
			'MyClass': 'readonly',
		},
	}),
	// other configs:
	jsdoc.configs['flat/recommended-typescript-flavor'],
]

SHORT

  • preferably ESM (but works good with CJS in strict mode)
  • <tab> for indentation
  • no semicolons (configurable)

Based on

neostandard javascript style

  • neostandard
  • eslint-plugin-unicorn

Also:

  • eslint-plugin-mocha
  • eslint-plugin-boundaries
  • eslint-plugin-import-x
  • eslint-plugin-astro
  • eslint-plugin-vue

Old versions

See README.old.md

OPTIONS

const eslintVlbCfg = eslintConfigVolebo({
	includeMocha: true,
	
	includeVue: false,
	includeAstro: false,
	includeUnoCss: false,
})

LICENSE

MIT

See LICENSE