@alexlit/config-prettier 16.6.3 → 17.0.0

package/README.md

@@ -8,14 +8,26 @@ npm i @alexlit/config-prettier -D
 
 ## Connection
 
-```js
-// prettier.config.js
-import config from '@alexlit/config-prettier';
+- Default
+  ([see plugins enabled by default](https://github.com/alex-lit/lint-kit/blob/master/packages/config-prettier/index.js#L5))
 
-export default {
-  ...config,
+  ```js
+  // prettier.config.js
+  import { createConfig } from '@alexlit/config-prettier';
 
-  // if additional plugins needed
-  plugins: [...config.plugins, 'your-favorite-plugin'],
-};
-```
+  export default createConfig();
+  ```
+
+- Custom
+
+  ```js
+  // prettier.config.js
+  import { createConfig } from '@alexlit/config-prettier';
+
+  export default createConfig({
+    php: true,
+    ruby: true,
+    sql: false,
+    tailwindcss: false,
+  });
+  ```

package/index.js

@@ -1,38 +1,97 @@
-/* eslint-disable spellcheck/spell-checker, import/extensions */
-import jsdoc from './plugins/jsdoc.js';
-import pug from './plugins/pug.js';
-import sortJson from './plugins/sort-json.js';
-import xml from './plugins/xml.js';
-
-export default {
-  endOfLine: 'lf',
-
-  plugins: [
-    '@prettier/plugin-php',
-    '@prettier/plugin-pug',
-    '@prettier/plugin-ruby',
-    '@prettier/plugin-xml',
-
-    'prettier-plugin-jsdoc',
-    'prettier-plugin-packagejson',
-    'prettier-plugin-sh',
-    'prettier-plugin-solidity',
-    'prettier-plugin-sort-json',
-    'prettier-plugin-sql',
-    // 'prettier-plugin-svelte',
-    // 'prettier-plugin-tailwindcss',
-  ],
-
-  proseWrap: 'always',
-  singleQuote: true,
-  tabWidth: 2,
-  trailingComma: 'all',
-  vueIndentScriptAndStyle: true,
-
-  ...jsdoc,
-  ...pug,
-  ...sortJson,
-  // ...svelte,
-  // ...tailwindcss,
-  ...xml,
+/* eslint-disable no-loops/no-loops, no-restricted-syntax, no-await-in-loop */
+
+import { omit } from 'radash';
+
+const PLUGINS = {
+  /** @see [prettier-plugin-jsdoc](https://github.com/hosseinmd/prettier-plugin-jsdoc) */
+  jsdoc: true,
+
+  /** @see [prettier-plugin-packagejson](https://github.com/matzkoh/prettier-plugin-packagejson) */
+  packagejson: true,
+
+  /** @see [plugin-php](https://github.com/prettier/plugin-php) */
+  php: false,
+
+  /** @see [plugin-pug](https://github.com/prettier/plugin-pug) */
+  pug: true,
+
+  /** @see [plugin-ruby](https://github.com/prettier/plugin-ruby) */
+  ruby: false,
+
+  /** @see [prettier-plugin-sh](https://github.com/astorije/prettier-plugin-sh) */
+  sh: true,
+
+  /** @see [prettier-plugin-solidity](https://github.com/prettier-solidity/prettier-plugin-solidity) */
+  solidity: true,
+
+  /** @see [prettier-plugin-sort-json](https://github.com/Gudahtt/prettier-plugin-sort-json) */
+  'sort-json': true,
+
+  /** @see [prettier-plugin-sql](https://github.com/un-ts/prettier/tree/master/packages/sql) */
+  sql: false,
+
+  /** @see [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte) */
+  svelte: false,
+
+  /** @see [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss) */
+  tailwindcss: false,
+
+  /** @see [plugin-xml](https://github.com/prettier/plugin-xml) */
+  xml: true,
+};
+
+/**
+ * Create plugins config list
+ *
+ * @param {PLUGINS} plugins Enabled/disabled plugins list
+ *
+ * @returns {import('prettier').Config} Prettier configuration
+ */
+const createPluginsConfig = async (plugins = {}) => {
+  let pluginsConfig = { plugins: [] };
+
+  const pluginEntries = Object.entries({ ...PLUGINS, ...plugins });
+
+  for (const [name, isActive] of pluginEntries) {
+    if (isActive) {
+      const { default: config } = await import(
+        `@alexlit/config-prettier/plugins/${name}.js`
+      );
+
+      if (config.plugins?.length > 0) {
+        pluginsConfig.plugins.push(...config.plugins);
+      }
+
+      pluginsConfig = { ...pluginsConfig, ...omit(config, ['plugins']) };
+    }
+  }
+
+  return pluginsConfig;
+};
+
+/**
+ * Create prettier config
+ *
+ * @param {PLUGINS} plugins
+ * @param {import('prettier').Config} options Prettier options
+ *
+ * @returns {import('prettier').Config} Prettier configuration
+ */
+export const createConfig = async (plugins = {}, options = {}) => {
+  const pluginsConfig = await createPluginsConfig(plugins);
+
+  return {
+    endOfLine: 'lf',
+
+    plugins: [...pluginsConfig.plugins, ...(options.plugins ?? [])],
+
+    proseWrap: 'always',
+    singleQuote: true,
+    tabWidth: 2,
+    trailingComma: 'all',
+    vueIndentScriptAndStyle: true,
+
+    ...omit(pluginsConfig, ['plugins']),
+    ...omit(options, ['plugins']),
+  };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alexlit/config-prettier",
-  "version": "16.6.3",
+  "version": "17.0.0",
   "private": false,
   "description": "prettier config",
   "keywords": [
@@ -45,7 +45,8 @@
     "prettier-plugin-sort-json": "^3.1.0",
     "prettier-plugin-sql": "^0.18.0",
     "prettier-plugin-svelte": "^3.2.2",
-    "prettier-plugin-tailwindcss": "^0.5.11"
+    "prettier-plugin-tailwindcss": "^0.5.12",
+    "radash": "^12.1.0"
   },
   "engines": {
     "node": ">=18.12.0"

package/plugins/jsdoc.js

@@ -1,6 +1,6 @@
-/** @see [prettier-plugin-jsdoc](https://github.com/hosseinmd/prettier-plugin-jsdoc) */
 export default {
   jsdocCommentLineStrategy: 'singleLine',
   jsdocSeparateReturnsFromParam: true,
   jsdocSeparateTagGroups: true,
+  plugins: ['prettier-plugin-jsdoc'],
 };

package/plugins/packagejson.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: ['prettier-plugin-packagejson'],
+};

package/plugins/php.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: ['@prettier/plugin-php'],
+};

package/plugins/pug.js

@@ -1,5 +1,6 @@
-/** @see [plugin-pug](https://github.com/prettier/plugin-pug) */
 export default {
+  plugins: ['@prettier/plugin-pug'],
+
   pugCommentPreserveSpaces: 'trim-all',
   pugSingleQuote: false,
   pugSortAttributes: 'asc',

package/plugins/ruby.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: ['@prettier/plugin-ruby'],
+};

package/plugins/sh.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: ['prettier-plugin-sh'],
+};

package/plugins/solidity.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: ['prettier-plugin-solidity'],
+};

package/plugins/sort-json.js

@@ -1,4 +1,5 @@
-/** @see [prettier-plugin-sort-json]https://github.com/Gudahtt/prettier-plugin-sort-json) */
 export default {
   jsonRecursiveSort: true,
+
+  plugins: ['prettier-plugin-sort-json'],
 };

package/plugins/sql.js

@@ -0,0 +1,3 @@
+export default {
+  plugins: ['prettier-plugin-sql'],
+};

package/plugins/svelte.js

@@ -1,5 +1,6 @@
-/** @see [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte) */
 export default {
+  plugins: ['prettier-plugin-svelte'],
+
   svelteAllowShorthand: false,
   svelteIndentScriptAndStyle: true,
   svelteSortOrder: 'options-scripts-markup-styles',

package/plugins/tailwindcss.js

@@ -1,4 +1,5 @@
-/** @see [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss) */
 export default {
+  plugins: ['prettier-plugin-tailwindcss'],
+
   tailwindFunctions: ['tw'],
 };

package/plugins/xml.js

@@ -1,4 +1,5 @@
-/** @see [plugin-xml](https://github.com/prettier/plugin-xml) */
 export default {
+  plugins: ['@prettier/plugin-xml'],
+
   xmlWhitespaceSensitivity: 'ignore',
 };