README.md

@terminal-nerds/syncpack-config

➡️ Extendable syncpack configuration, part of the terminal-nerds/configs project.

---

Prerequisites

ℹ️ This configuration package require these tools to use locally on your device(s):

1. Latest Node.js LTS (Long-Term Support) version
2. One of Node.js package managers:
   • pnpm
   • yarn
   • npm
3. Latest syncpack version

---

Basic usage

👣 Follow the steps below:

1. Install it with the Node.js package manager of your choice (in our case, we use pnpm).

    pnpm install --save-dev syncpack @terminal-nerds/syncpack-config

2. Create an syncpack configuration file - syncpackrc.config.js.

3. Extend this module package configuration.

   import { CONFIG } from "@terminal-nerds/syncpack-config";
   
   const config = {
   	...CONFIG,
   };
   
   export default config;

📖 For the syncpack CLI usage, please refer to its documentation.

---

Used configurations & plugins

None, so far.

---

Security

🔐 For more information, please refer to the Security section at the root of the terminal-nerds/configs monorepo.

---

Contributing

🤝 Contributions of any kind are welcome!

Please refer to our CONTRIBUTING file (at the root of this project repository - terminal-nerds/configs) for more information if you wish to get involved.

---

License

⚖️ For more information, please refer to the License section at the root of the terminal-nerds/configs monorepo.