Skip to content

Configuration basics for Linters, TypeScript, Semantic Release and others

License

Notifications You must be signed in to change notification settings

tsofist/web-buddy

Repository files navigation

Concept

This is a set of pre-configured configurations for quickly starting web projects of the JS family. You can simply clone this repository, make the necessary changes, and easily connect it to your projects.

Thus, all projects using this repository will have uniform settings for styling, building, and other things. Exceptions can always be localized in the package.json file of a specific project.

What's included?

  • ESLint TypeScript, JavaScript, Yaml, VueJS, JSON
  • Stylelint Vue, SCSS, PostCSS, HTML
  • Prettier
  • .editorconfig
  • TypeScript
  • Semantic release GitHub, Gitlab

How to use

As concept or sample

Your project may differ significantly from the configurations collected in this repository, so you can simply fork this project and make your own changes. Alternatively, you can use this repository as a sample for creating your own.

Directly

All specified configurations are easily extensible, so simply use the configuration extension, for example in package.json:

{
  "scripts": {
    "prepare": "husky && (cp node_modules/@tsofist/web-buddy/.editorconfig \"$INIT_CWD\" || true)"
  },
  "prettier": "./node_modules/@tsofist/web-buddy/.prettierrc.js",
  "stylelint": {
    "extends": "./node_modules/@tsofist/web-buddy/.stylelintrc.yaml"
  },
  "eslintConfig": {
    "root": true,
    "extends": [
      "./node_modules/@tsofist/web-buddy/.eslintrc.yaml"
    ]
  },
  "release": {
    "extends": [
      "@tsofist/web-buddy/.releaserc.json"
    ]
  }
}

Or for extra strictness:

{
  "eslintConfig": {
    "root": true,
    "extends": [
      "./node_modules/@tsofist/web-buddy/.eslintrc.yaml",
      "./node_modules/@tsofist/web-buddy/eslint/stricter.extends.yaml"
    ]
  }
}

About

Configuration basics for Linters, TypeScript, Semantic Release and others

Resources

License

Stars

Watchers

Forks

Packages

No packages published