@lqbach/prettier-config 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -1,34 +1,50 @@
 # Changelog
 
-## [0.2.2](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.2.1...prettier-config-v0.2.2) (2023-11-14)
+## [0.3.0](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.2.2...prettier-config-v0.3.0) (2023-11-21)
+
+
+### Features 🚀
+
+* add perfectionist sorting for eslint ([b2d8205](https://github.com/lqbach/eslint-prettier-config/commit/b2d8205314b5fe72675afd87a960864018e10782))
+* prettier sorted imports ([c12ede2](https://github.com/lqbach/eslint-prettier-config/commit/c12ede2941863b767810495ee8b5c3cc6691e430))
+* remove import sorting with Prettier ([e099751](https://github.com/lqbach/eslint-prettier-config/commit/e099751d8349b561a15df711e09cfc6763e6b48a))
+
+
+### Chores 🧹
+
+* add husky pre-commit ([db5cdfa](https://github.com/lqbach/eslint-prettier-config/commit/db5cdfa5ce036cebbdbf1edd23885aa1719c27cd))
+* add licensing to package ([e18f4f3](https://github.com/lqbach/eslint-prettier-config/commit/e18f4f36cf44fac1da5906094f2dc9ca2ea2f2d9))
+* add peerDependency for prettier plugin sort ([bf72608](https://github.com/lqbach/eslint-prettier-config/commit/bf72608f71af816b29825ae914514565870f5a84))
 
 
 ### Documentation 📝
 
-* add new readme docs ([b2b0044](https://github.com/lqbach/eslint-prettier-config/commit/b2b004442723e81299e10a2945e9f616324ac06a))
+* align badges ([8e7c4e1](https://github.com/lqbach/eslint-prettier-config/commit/8e7c4e1bcbd7ac7321ae02b21ce0ccf19e70a471))
 
-## [0.2.1](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.2.0...prettier-config-v0.2.1) (2023-11-14)
+## [0.2.2](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.2.1...prettier-config-v0.2.2) (2023-11-14)
+
+### Documentation 📝
+
+- add new readme docs ([b2b0044](https://github.com/lqbach/eslint-prettier-config/commit/b2b004442723e81299e10a2945e9f616324ac06a))
 
+## [0.2.1](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.2.0...prettier-config-v0.2.1) (2023-11-14)
 
 ### Bug Fixes
 
-* update package visiblity ([2c332e1](https://github.com/lqbach/eslint-prettier-config/commit/2c332e19165da93881d6ee61b75560041f9a5397))
+- update package visiblity ([2c332e1](https://github.com/lqbach/eslint-prettier-config/commit/2c332e19165da93881d6ee61b75560041f9a5397))
 
 ## [0.2.0](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.1.0...prettier-config-v0.2.0) (2023-11-14)
 
-
 ### Features
 
-* add new repository key to package ([d63ceb7](https://github.com/lqbach/eslint-prettier-config/commit/d63ceb7e9a348efc322ecdcb5d462cee6a2b05b8))
+- add new repository key to package ([d63ceb7](https://github.com/lqbach/eslint-prettier-config/commit/d63ceb7e9a348efc322ecdcb5d462cee6a2b05b8))
 
 ## 0.1.0 (2023-11-14)
 
-
 ### Bug Fixes
 
-* update name in package descriptions ([103aeb8](https://github.com/lqbach/eslint-prettier-config/commit/103aeb876f9ef22177e66a6946f8a257dc7479cd))
-
+- update name in package descriptions ([103aeb8](https://github.com/lqbach/eslint-prettier-config/commit/103aeb876f9ef22177e66a6946f8a257dc7479cd))
 
 ### Miscellaneous Chores
 
-* release 0.1.0 ([7cb7162](https://github.com/lqbach/eslint-prettier-config/commit/7cb7162ec233343991bdcfeaadb1caff612c5c9f))
+- release 0.1.0 ([7cb7162](https://github.com/lqbach/eslint-prettier-config/commit/7cb7162ec233343991bdcfeaadb1caff612c5c9f))

package/README.md

@@ -0,0 +1,12 @@
+<h1 align="center">@lqbach/prettier-config</h1>
+
+<div align="center">
+    <a href="https://www.npmjs.com/package/@lqbach/prettier-config">
+        <img src="https://img.shields.io/npm/v/@lqbach/prettier-config?color=444E5F&label=version&labelColor=BDD4E7" alt="npm-package"/>
+    </a>
+    <a href="https://www.npmjs.com/package/@lqbach/prettier-config">
+        <img src="https://img.shields.io/github/license/lqbach/eslint-prettier-config?labelColor=BDD4E7&color=444E5F" alt="license"/>
+    </a>
+    <img src="https://img.shields.io/github/release-date/lqbach/eslint-prettier-config?labelColor=BDD4E7&color=444E5F" alt="release-date"/>
+
+</div>

package/dist/index.cjs

@@ -20,14 +20,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  default: () => src_default
+  default: () => config
 });
 module.exports = __toCommonJS(src_exports);
-var src_default = {
-  printWidth: 80,
-  tabWidth: 2,
-  useTabs: false,
-  semi: false,
-  singleQuote: false,
-  bracketSpacing: true
-};
+function config() {
+  return {
+    bracketSpacing: true,
+    printWidth: 80,
+    semi: false,
+    singleQuote: false,
+    tabWidth: 2,
+    useTabs: false
+  };
+}

package/dist/index.js

@@ -1,12 +1,14 @@
 // src/index.ts
-var src_default = {
-  printWidth: 80,
-  tabWidth: 2,
-  useTabs: false,
-  semi: false,
-  singleQuote: false,
-  bracketSpacing: true
-};
+function config() {
+  return {
+    bracketSpacing: true,
+    printWidth: 80,
+    semi: false,
+    singleQuote: false,
+    tabWidth: 2,
+    useTabs: false
+  };
+}
 export {
-  src_default as default
+  config as default
 };

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@lqbach/prettier-config",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "private": false,
   "description": "lqbach's Personal Prettier Config",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/lqbach/eslint-prettier-config.git",

package/src/index.ts

@@ -1,8 +1,12 @@
-export default {
-  printWidth: 80,
-  tabWidth: 2,
-  useTabs: false,
-  semi: false,
-  singleQuote: false,
-  bracketSpacing: true,
+import { Config } from "prettier"
+
+export default function config(): Config {
+  return {
+    bracketSpacing: true,
+    printWidth: 80,
+    semi: false,
+    singleQuote: false,
+    tabWidth: 2,
+    useTabs: false,
+  }
 }

package/src/types.ts

@@ -0,0 +1,5 @@
+export interface PrettierConfigParams {
+  importOrder?: Array<string>
+  react?: boolean
+  vue?: boolean
+}

package/src/utils.ts

@@ -0,0 +1,27 @@
+/**
+ * Takes in an array of import order strings and groups them into chunks by adding an empty string between each item in the array.
+ *
+ * Reference: [README `prettier-plugin-sort-imports`](https://github.com/IanVS/prettier-plugin-sort-imports#3-add-spaces-between-import-groups)
+ * @param arr an array of import order strings
+ * @returns same array item separated by exactly one empty string between each item
+ */
+
+export const cleanSortImportsArray = (arr: Array<string>): Array<string> => {
+  // remove empty strings
+  const arrRemoveEmpty = arr.filter((val) => val !== "")
+
+  // clean array
+  const clean: Array<string> = arrRemoveEmpty.reduce(
+    (result: Array<string>, item: string, index: number) => {
+      result.push(item)
+
+      if (index < arrRemoveEmpty.length - 1) {
+        result.push("")
+      }
+      return result
+    },
+    [],
+  )
+
+  return clean
+}

package/test/utils.spec.ts

@@ -0,0 +1,32 @@
+import { describe, expect, test } from "vitest"
+
+import { cleanSortImportsArray } from "../src/utils"
+
+const inputA1 = ["hey", "jude"]
+const inputA2 = ["hey", "", "", "jude"]
+const inputA3 = ["hey", "", "jude", ""]
+const inputA4 = ["", "hey", "", "jude", ""]
+
+const outputExpectedA = ["hey", "", "jude"]
+
+describe("cleanSortImportsArray", () => {
+  test("test with ['hey', 'jude']", async () => {
+    const output = cleanSortImportsArray(inputA1)
+    expect(output).toStrictEqual(outputExpectedA)
+  })
+
+  test("test with ['hey', '', '', 'jude']", async () => {
+    const output = cleanSortImportsArray(inputA2)
+    expect(output).toStrictEqual(outputExpectedA)
+  })
+
+  test("test with ['hey', '', 'jude', '']", async () => {
+    const output = cleanSortImportsArray(inputA3)
+    expect(output).toStrictEqual(outputExpectedA)
+  })
+
+  test("test with ['', 'hey', '', 'jude', '']", async () => {
+    const output = cleanSortImportsArray(inputA4)
+    expect(output).toStrictEqual(outputExpectedA)
+  })
+})

package/tsconfig.json

@@ -1,17 +1,15 @@
 {
-    "compilerOptions": {
-      "target": "es2022",
-      "module": "commonjs",
-      "moduleResolution": "node",
-      "declaration": true,
-      "strict": true,
-      "incremental": true,
-      "esModuleInterop": true,
-      "skipLibCheck": true,
-      "forceConsistentCasingInFileNames": true,
-      "rootDir": "./src",
-      "outDir": "./dist",
-      "composite": true
-    }
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "strict": true,
+    "incremental": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "composite": true
   }
-  
+}