Add prettier

.github/workflows/ci.yml

@@ -25,3 +25,7 @@ jobs:
 
       - name: Typecheck
         run: npm run tsc
+
+      - name: Check Format
+        id: npm-format-check
+        run: npm run format:check

.prettierignore

@@ -0,0 +1,5 @@
+.DS_Store
+.licenses/
+dist/
+node_modules/
+coverage/

.prettierrc.yml

@@ -0,0 +1,14 @@
+printWidth: 80
+tabWidth: 2
+useTabs: false
+semi: false
+singleQuote: true
+quoteProps: as-needed
+jsxSingleQuote: false
+trailingComma: none
+bracketSpacing: true
+bracketSameLine: true
+arrowParens: always
+proseWrap: always
+htmlWhitespaceSensitivity: css
+endOfLine: lf

README.md

@@ -1,12 +1,18 @@
 # workflow-timer
 
-Workflow-timer is a GitHub action that measures the duration of the workflow and compares it to the duration of historical runs.
+Workflow-timer is a GitHub action that measures the duration of the workflow and
+compares it to the duration of historical runs.
 
-The action should be triggered on `pull_requests` hence it will create a comment on the PR with information like:
+The action should be triggered on `pull_requests` hence it will create a comment
+on the PR with information like:
 
 `🕒 Workflow "Unit tests" took 22.056s which is a decrease with 6.944s (23.94%) compared to latest run on master/main.`
 
-The purpose of this action is to make the developer aware of when feedbacks loops get longer. Let's say that you are running unit tests as part of your current workflow. If merging your changes (your PR) would increase the time it takes to run the unit tests by 50%, your changes probably have unwanted side effects. It's about creating awareness for the developer.
+The purpose of this action is to make the developer aware of when feedbacks
+loops get longer. Let's say that you are running unit tests as part of your
+current workflow. If merging your changes (your PR) would increase the time it
+takes to run the unit tests by 50%, your changes probably have unwanted side
+effects. It's about creating awareness for the developer.
 
 ## How to use it
 
@@ -17,7 +23,10 @@ As the **very last job** in your workflow, add
   uses: DeviesDevelopment/workflow-timer@v0.0.2
 ```
 
-Workflow-timer compares the current workflow run with the latest run on the master/main branch. Therefore, the same workflow needs to run when merging with the master as well, otherwise, there will be no data to compare. We suggest having the following definition in the workflow:
+Workflow-timer compares the current workflow run with the latest run on the
+master/main branch. Therefore, the same workflow needs to run when merging with
+the master as well, otherwise, there will be no data to compare. We suggest
+having the following definition in the workflow:
 
 ```yaml
 on:
@@ -29,4 +38,5 @@ on:
 
 ## How to contribute
 
-Feel free to open a pull request! All contributions, no matter how small, are more than welcome. Happy hacking!
+Feel free to open a pull request! All contributions, no matter how small, are
+more than welcome. Happy hacking!

action.yml

@@ -1,12 +1,14 @@
-name: "Workflow Timer"
-description: "Measures the duration of the workflow and compares it to the duration of historical runs."
+name: 'Workflow Timer'
+description:
+  'Measures the duration of the workflow and compares it to the duration of
+  historical runs.'
 branding:
-  icon: "clock"
-  color: "green"
+  icon: 'clock'
+  color: 'green'
 inputs:
   token:
-    description: "GITHUB_TOKEN or a repo scoped PAT."
+    description: 'GITHUB_TOKEN or a repo scoped PAT.'
     default: ${{ github.token }}
 runs:
-  using: "node20"
-  main: "dist/index.js"
+  using: 'node20'
+  main: 'dist/index.js'

package.json

@@ -12,10 +12,12 @@
     "node": ">=20"
   },
   "scripts": {
+    "format:write": "npx prettier --write .",
+    "format:check": "npx prettier --check .",
     "package": "npx rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
     "package:watch": "npm run package -- --watch",
     "tsc": "tsc --noEmit",
-    "all": "npm run tsc && npm run package"
+    "all": "npm run format:write && npm run tsc && npm run package"
   },
   "dependencies": {
     "@actions/core": "^1.11.1",
@@ -26,6 +28,7 @@
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/node": "^22.15.2",
+    "prettier": "^3.5.3",
     "rollup": "^4.40.0",
     "tslib": "^2.8.1",
     "typescript": "^5.8.3"

rollup.config.ts

@@ -1,18 +1,18 @@
 // See: https://rollupjs.org/introduction/
 
-import commonjs from "@rollup/plugin-commonjs";
-import nodeResolve from "@rollup/plugin-node-resolve";
-import typescript from "@rollup/plugin-typescript";
+import commonjs from '@rollup/plugin-commonjs'
+import nodeResolve from '@rollup/plugin-node-resolve'
+import typescript from '@rollup/plugin-typescript'
 
 const config = {
-  input: "src/index.ts",
+  input: 'src/index.ts',
   output: {
     esModule: true,
-    file: "dist/index.js",
-    format: "es",
-    sourcemap: true,
+    file: 'dist/index.js',
+    format: 'es',
+    sourcemap: true
   },
-  plugins: [typescript(), nodeResolve({ preferBuiltins: true }), commonjs()],
-};
+  plugins: [typescript(), nodeResolve({ preferBuiltins: true }), commonjs()]
+}
 
-export default config;
+export default config

src/index.ts

@@ -1,3 +1,3 @@
-import { run } from "./main.js";
+import { run } from './main.js'
 
-run();
+run()