Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.53 KB

README.md

File metadata and controls

65 lines (45 loc) · 1.53 KB

@wopjs/eslint-config

Build Status npm-version

Wopjs eslint config. It aims to enforce code style that is consistent and diff-friendly, easy to review.

Features

  • Flat config.
  • Respects .gitignore.
  • Prettier compatible.
  • TypeScript configured.
  • Import sorting and field sorting.

Install

npm add -D @wopjs/eslint-config

Usage

// eslint.config.js
import wopjs from "@wopjs/eslint-config";

export default wopjs;

Add your own rules to the flat config.

// eslint.config.js
import wopjs from "@wopjs/eslint-config";

export default {
  ...wopjs,
  {
    rules: {
      "no-console": "off",
    },
  }
};

Development

Publish New Version

You can use npm version to bump version.

npm version patch

Push the tag to remote and CI will publish the new version to npm.

git push --follow-tags

CI Auto Publish

If you want to publish the package in CI, you need to set the NPM_TOKEN secrets in GitHub repository settings. See how to create a NPM access token.