@diesdasdigital/linting

A reusable set of linting rules for use with any Diesdas internal project which uses Stylelint and/or Eslint.

Getting Started

Install @diesdasdigital/linting, stylelint and eslint to your project.

yarn add --dev @diesdasdigital/linting stylelint eslint

Create a new stylelint.config.js file at the root of your project, which extends @diesdasdigital/linting/stylelint-config.

// stylelint.config.js

module.exports = {
  extends: "@diesdasdigital/linting/stylelint-config",
  rules: {
    // Your project-specific rules and overrides go here
  },
};

Create a new .eslintrc.js file at the root of your project, which extends @diesdasdigital/linting/eslint-config.

// .eslintrc.js

module.exports = {
  extends: ["./node_modules/@diesdasdigital/linting/eslint-config"],
  rules: {
    // Your project-specific rules and overrides go here
  },
};

You're done!

Package Maintenance

Releasing a new version

This project uses the npm-publish-action to automatically publish new releases to NPM and tag them on Github. To trigger a new release, then commit a change to the version number in package.json with the commit message Release x.x.x (but replace x.x.x with the new version number). Push the commit to origin/main and then view the status of the automated release here.