0.2.0 • Published 1 year ago

@adchitects/eslint-config v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@adchitects/eslint-config

package version badge

➡️ Extendable eslint icon configuration, part of the adchitects/configs project.


Prerequisites

node.js version support badge supported eslint version badge

ℹ️ This configuration package require these tools to use locally on your device(s):

  1. node.js icon Latest Node.js LTS (Long-Term Support) version
  2. One of Node.js package managers:
    • pnpm icon
    • yarn icon
    • npm icon
  3. Latest eslint icon version

Basic usage

👣 Follow the steps below:

  1. Install it with the node.js icon package manager of your choice (in our case, we use pnpm icon).

     pnpm install --save-dev eslint @adchitects/eslint-config
  2. Create an eslint icon - .eslintrc.(c)js.

  3. Extend this module package configuration.

    const config = {
    	extends: "@adchitects",
    
    	env: {
    		// Specify the environment(s)
    		// https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments
    		browser: true,
    		node: true,
    	},
    };
    
    module.exports = config;

📖 For the eslint icon usage, please refer to its documentation.


Used configurations & plugins

Dependencies badge

⚙️ This configuration module loads configurations and plugins options conditionally.

Configurations

ConfigurationsVersionLoading condition(s)
eslint-config-nexteslint-config-next version badgenext as dependency
eslint-config-prettiereslint-config-prettier version badgeprettier as dependency

Plugins

PluginVersionLoading condition(s)
@typescript-eslint/eslint-plugin@typescript-eslint/eslint-plugin version badgetypescript as dependency
eslint-plugin-compateslint-plugin-compat version badge-
eslint-plugin-diffeslint-plugin-diff version badgeSet one of environment variables: CI or CONTINUOUS_INTEGRATION to true
@emotion/eslint-plugin@emotion/eslint-plugin version badge@emotion/css or @emotion/react as dependency
eslint-plugin-importeslint-plugin-import version badge-
eslint-plugin-jesteslint-plugin-jest version badgejest or vitest as dependency
eslint-plugin-jest-domeslint-plugin-jest-dom version badge@testing-library/jest-dom as dependency
eslint-plugin-jest-formattingeslint-plugin-jest-formatting version badgejest or vitest as dependency
eslint-plugin-json-schema-validatoreslint-plugin-json-schema-validator version badge-
eslint-plugin-jsonceslint-plugin-jsonc version badge-
eslint-plugin-jsx-a11yeslint-plugin-jsx-a11y version badgereact or preact as dependency
eslint-plugin-nodeeslint-plugin-node version badge-
eslint-plugin-reacteslint-plugin-react version badgereact or preact as dependency
eslint-plugin-react-hookseslint-plugin-react-hooks version badgereact or preact as dependency
eslint-plugin-regexpeslint-plugin-regexp version badge-
eslint-plugin-sonarjseslint-plugin-sonarjs version badge-
eslint-plugin-sqleslint-plugin-sql version badge-
eslint-plugin-storybookeslint-plugin-storybook version badgesb or storybook or @storybook/react as dependency
eslint-plugin-testing-libraryeslint-plugin-testing-library version badge@testing-library/jest-dom as dependency
eslint-plugin-unicorneslint-plugin-unicorn version badge-
eslint-plugin-ymleslint-plugin-yml version badge-

Security

workflow security badge

🔐 For more information, please refer to the Security section at the root of the adchitects/configs monorepo.


Contributing

contributors badge

🤝 Contributions of any kind are welcome!

Please refer to the monorepo (adchitects/configs) project's CONTRIBUTING file for more information if you wish to get involved.


License

license badge

⚖️ For more information, please refer to the License section at the root of the adchitects/configs monorepo.


Resources