@devpow112/eslint-config

ESLint Configuration

Shareable eslint configuration.

Installation

npm i -D @devpow112/eslint-config

Usage

The shareable config can be configured in the ESLint Configuration file. There are currently 2 config types nodeConfigs and testConfigs. They will work for both commonjs and module based set-ups.

commonjs

const { nodeConfigs, testConfigs } = require('@devpow112/eslint-config');
const { defineConfig } = require('eslint/config');
const { includeIgnoreFile } = require('@eslint/compat');
const { resolve } = require('node:path');

const gitignorePath = resolve(__dirname, '.gitignore');

module.exports = defineConfig([
  includeIgnoreFile(gitignorePath),
  ...nodeConfigs,
  ...testConfigs
]);

modules

import { nodeConfigs, testConfigs } from './src/index.js';
import { defineConfig } from 'eslint/config';
import { fileURLToPath } from 'node:url';
import { includeIgnoreFile } from '@eslint/compat';

const gitignorePath = fileURLToPath(new URL('.gitignore', import.meta.url));

export default defineConfig([
  includeIgnoreFile(gitignorePath),
  ...nodeConfigs,
  ...testConfigs
]);

Development

Development can be done on any machine that can install Node.js. Only the latest LTS version is tested against.

Install Dependencies

Install dependencies via npm.

npm i

Linting

Execute linters via npm.

# git, javascript, markdown and package.json
npm run lint

# git only
npm run lint:git

# javascript only
npm run lint:js

# markdown only
npm run lint:md

# package.json only
npm run lint:pkg

Fixing

Execute automatic fixers via npm.

# javascript, markdown and package.json
npm run fix

# javascript only
npm run fix:js

# markdown only
npm run fix:md

# package.json only
npm run fix:pkg