symlink-config

A tool to symlink your project config files to root

Why

Make the root of your project cleaner when checking on the repo hub.
Keep your JavaScript repository clean

Demo

You can check this repo! It has configs for eslint, prettier, lint-staged, husky, and commitlint.
All configs are in ./support/root.

Usage

npm install symlink-config

In package.json:

  "scripts": {
    "prepare": "npx symlink-config"
  }

Move and link a config file

npx symlink-config .eslintrc.js # will move the eslint config to ./support/root/ by default

If you want to change the name of your sourceDir for config files:

  "scripts": {
    "prepare": "npx symlink-config"
  },
  "symlink-config": {
    "path": "./allRootConfigs"
  }