# symlink-config

> A tool to symlink your project config files to root

Latest version **0.2.0** (published 2022-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install symlink-config
pnpm add symlink-config
yarn add symlink-config
bun add symlink-config
```

Provides the command `symlink-config`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2022-05-25 |
| First published | 2022-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Dragoș Străinu @strdr4605 |
| Maintainers | strdr4605 |
| Keywords | symlink, config, root |

## Links

- npm: https://www.npmjs.com/package/symlink-config
- Repository: https://github.com/strdr4605/symlink-config
- Homepage: https://github.com/strdr4605/symlink-config#readme
- Issues: https://github.com/strdr4605/symlink-config/issues
- npm.io page: https://npm.io/package/symlink-config

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2022-05-25
- 0.1.2 — 2022-04-08
- 0.1.1 — 2022-04-07
- 0.1.0 — 2022-04-06

## 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"
  }
```

---
_Source: https://npm.io/package/symlink-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._