https://github.com/strdr4605/symlink-config

A tool to symlink your project config files to root
https://github.com/strdr4605/symlink-config

config node npm npm-cli npm-install npm-package symlinks

Last synced: 2 months ago
JSON representation

A tool to symlink your project config files to root

• Host: GitHub
• URL: https://github.com/strdr4605/symlink-config
• Owner: strdr4605
• License: mit
• Created: 2022-04-01T15:49:10.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-05-25T12:55:56.000Z (over 2 years ago)
• Last Synced: 2024-07-17T23:14:39.717Z (3 months ago)
• Topics: config, node, npm, npm-cli, npm-install, npm-package, symlinks
• Language: JavaScript
• Homepage: https://npm.im/symlink-config
• Size: 18.6 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# symlink-config 

![version](https://badgen.net/npm/v/symlink-config)

![npm downloads](https://badgen.net/npm/dm/symlink-config)

![dependents](https://badgen.net/npm/dependents/symlink-config)

![publish](https://badgen.net/packagephobia/publish/symlink-config)

[![Hits-of-Code](https://hitsofcode.com/github/strdr4605/symlink-config?branch=master)](https://hitsofcode.com/github/strdr4605/symlink-config/view?branch=master)

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](https://strdr4605.com/keep-your-java-script-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](/support/root).

## Usage

```bash

npm install symlink-config

```

In package.json:

```json

  "scripts": {

    "prepare": "npx symlink-config"

  }

```

Move and link a config file

```bash

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:

```json

  "scripts": {

    "prepare": "npx symlink-config"

  },

  "symlink-config": {

    "path": "./allRootConfigs"

  }

```