chore: 🤖 apply latest learnings from prettier config (#156)

.eslintrc.json

@@ -1,10 +1,6 @@
 {
-  "extends": ["jimmy-guzman", "jimmy-guzman/typescript", "jimmy-guzman/jest"],
+  "extends": ["jimmy-guzman", "jimmy-guzman/typescript", "jimmy-guzman/vitest"],
   "parserOptions": {
     "project": ["./tsconfig.json"]
-  },
-  "rules": {
-    "sort-keys": "off",
-    "jest/no-deprecated-functions": "off"
   }
 }

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ['20']
+        node: ["20"]
 
     steps:
       - name: 🏗 Setup Repository
@@ -27,6 +27,10 @@ jobs:
   commit_check:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+      pull-requests: read
+
     steps:
       - name: 🏗 Setup Repository
         uses: actions/checkout@v4

.prettierignore

@@ -1,8 +1,2 @@
 CHANGELOG.md
-.cache
-.reports
-.yalc
-dist
-coverage
-pnpm-lock.yaml
 

README.md

@@ -7,20 +7,12 @@
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://semantic-release.gitbook.io/semantic-release)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square&logo=prettier)](https://github.com/prettier/prettier)
 
-<!-- ![description starts here] -->
-
 > 🍱 another opinionated TypeScript library starter
 
-<!-- ![description ends here] -->
-
-<!-- ![usage starts here] -->
-
-## Usage
+## 🛠️ Usage
 
 - [create a `NPM_TOKEN`](https://docs.npmjs.com/about-access-tokens)
 - add `NPM_TOKEN` as [repository secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
 - [create codecov account](https://docs.codecov.io/docs/quick-start)
 - replace `ts-starter` and `jimmy-guzman`
 - remove `--dry-run` from `.github/workflows/release.yml`
-
-<!-- ![usage ends here] -->

cspell.json

@@ -5,7 +5,6 @@
     "Codecov",
     "commitlint",
     "commitlintrc",
-    "comparto",
     "corepack",
     "dbaeumer",
     "deps",
@@ -25,8 +24,7 @@
     "streetsidesoftware",
     "typecheck",
     "vitest",
-    "wagoid",
-    "yalc"
+    "wagoid"
   ],
   "ignorePaths": [
     "node_modules", // this will ignore anything the node_modules directory

package.json

@@ -1,6 +1,7 @@
 {
   "name": "ts-starter",
   "version": "0.0.0",
+  "description": "",
   "keywords": [],
   "repository": {
     "type": "git",
@@ -36,10 +37,12 @@
     "coverage": "vitest run --coverage",
     "typecheck": "tsc",
     "prepack": "pnpm build && clean-pkg-json",
-    "prepare": "lefthook install"
+    "prepare": "is-ci || lefthook install"
   },
+  "prettier": "@jimmy.codes/prettier-config",
   "devDependencies": {
     "@commitlint/config-conventional": "19.1.0",
+    "@jimmy.codes/prettier-config": "1.0.1",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "12.0.0",
     "@semantic-release/git": "10.0.1",
@@ -52,6 +55,7 @@
     "eslint": "8.57.0",
     "eslint-config-jimmy-guzman": "14.1.0",
     "gitzy": "5.2.0",
+    "is-ci": "3.0.1",
     "lefthook": "1.6.7",
     "pkgroll": "2.0.2",
     "prettier": "3.2.5",

src/index.spec.ts

@@ -1,5 +1,5 @@
-import { lib } from './index'
+import { lib } from "./index";
 
-test('lib', () => {
-  expect(lib).toBe('')
-})
+test("lib", () => {
+  expect(lib).toBe("");
+});

src/index.ts

@@ -1 +1 @@
-export const lib = ''
+export const lib = "";

vitest.config.ts

@@ -1,10 +1,10 @@
-import { defineConfig } from 'vitest/config'
+import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
     globals: true,
     coverage: {
-      reporter: ['json', 'text-summary'],
+      reporter: ["json", "text-summary"],
     },
   },
-})
+});