@terminal-nerds/prettier-config

Extendable Prettier 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 Prettier 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 prettier @terminal-nerds/prettier-config

1. Create an Prettier configuration file - .prettierrc.js.

2. Extend this module package configuration.

   /** @type import("prettier").Options */
   const config = {
   	...import("@terminal-nerds/prettier-config"),
   };
   
   export default config;

📖 For prettier icon Prettier CLI usage, please refer to its documentation

Used configurations & plugins

⚙️ This configuration module for Prettier loads plugins options conditionally.

Plugins

| Plugin | Version | Loading condition(s) | | ------------------------------------- | ---------------------------------------------------- | --------------------------- | | prettier-plugin-astro | | astro as dependency | | [prettier-plugin-jsdoc] | ![prettier-plugin-jsdoc version badge] | - | | prettier-plugin-sort-markdown-table | | - | | prettier-plugin-svelte | | svelte as dependency | | prettier-plugin-tailwindcss | | tailwindcss as dependency |

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 the monorepo (terminal-nerds/configs) project's CONTRIBUTING file 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.