build: speed up builds & prepare release (#48)

- bump dependencies
- document contributing guidelines
- speed up builds by triggering them only when necessary
- bump release version

Author: castarco

.editorconfig

@@ -4,7 +4,7 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-[*.{css,js,cjs,mjs,json,ts,cjs,mts,jsx,tsx,md}]
+[*.{css,js,cjs,mjs,json,ts,cjs,mts,jsx,tsx,md,sh}]
 charset = utf-8
 indent_style = tab
 indent_size = 2

.github/workflows/tests.yml

@@ -38,7 +38,7 @@ jobs:
     - name: (Types) Install dependencies
       run: pnpm --filter types install
     - name: (Types) Build Library
-      run: pnpm --filter types run build
+      run: pnpm --filter types run build:ci
     - name: (Types) Run Linters
       if: ${{ matrix.os == 'ubuntu-22.04' }}
       run: pnpm --filter types run lint
@@ -47,7 +47,7 @@ jobs:
     - name: (Algorithms) Install dependencies
       run: pnpm --filter algorithms install
     - name: (Algorithms) Build Library
-      run: pnpm --filter algorithms run build
+      run: pnpm --filter algorithms run build:ci
     - name: (Algorithms) Run Linters
       if: ${{ matrix.os == 'ubuntu-22.04' }}
       run: pnpm --filter algorithms run lint
@@ -58,7 +58,7 @@ jobs:
     - name: (React SVG) Install dependencies
       run: pnpm --filter react install
     - name: (React SVG) Build Library
-      run: pnpm --filter react run build
+      run: pnpm --filter react run build:ci
     - name: (React SVG) Run Linters
       if: ${{ matrix.os == 'ubuntu-22.04' }}
       run: pnpm --filter react run lint

@beautiful-tree/algorithms/package.json

@@ -37,7 +37,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf dist && rollup --config rollup.config.prod.mjs",
+    "build": "../../scripts/build.sh algorithms",
+    "build:ci": "rollup --config rollup.config.prod.mjs",
     "build-storybook": "storybook build",
     "lint": "tsc && eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0 && publint",
     "lint:eslint": "eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0",
@@ -50,20 +51,20 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.10.2",
-    "@beautiful-tree/types": "workspace:0.2.0",
+    "@beautiful-tree/types": "workspace:*",
     "@coderspirit/eslint-config": "^1.2.1",
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.3",
-    "@types/node": "^20.6.1",
-    "@typescript-eslint/parser": "^6.7.0",
-    "@vitest/coverage-v8": "^0.34.4",
-    "eslint": "^8.49.0",
+    "@types/node": "^20.6.4",
+    "@typescript-eslint/parser": "^6.7.2",
+    "@vitest/coverage-v8": "^0.34.5",
+    "eslint": "^8.50.0",
     "prettier": "^3.0.3",
     "publint": "^0.2.2",
-    "rollup": "^3.29.1",
+    "rollup": "^3.29.3",
     "rollup-plugin-dts": "^5.3.1",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2",
-    "vitest": "^0.34.4"
+    "vitest": "^0.34.5"
   }
 }

@beautiful-tree/react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beautiful-tree/react",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "author": "Andres Correa Casablanca <[email protected]>",
   "license": "MIT",
@@ -37,7 +37,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf dist && rollup --config rollup.config.prod.mjs",
+    "build": "../../scripts/build.sh react",
+    "build:ci": "rollup --config rollup.config.prod.mjs",
     "build-storybook": "storybook build",
     "lint": "tsc && eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0 && publint",
     "lint:eslint": "eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0",
@@ -51,41 +52,41 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.10.2",
-    "@beautiful-tree/algorithms": "workspace:0.2.0",
-    "@beautiful-tree/types": "workspace:0.2.0",
+    "@beautiful-tree/algorithms": "workspace:*",
+    "@beautiful-tree/types": "workspace:*",
     "@coderspirit/eslint-config": "^1.2.1",
     "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.3",
-    "@storybook/addon-essentials": "^7.4.2",
-    "@storybook/addon-interactions": "^7.4.2",
-    "@storybook/addon-links": "^7.4.2",
-    "@storybook/blocks": "^7.4.2",
-    "@storybook/react": "^7.4.2",
-    "@storybook/react-vite": "^7.4.2",
+    "@storybook/addon-essentials": "^7.4.4",
+    "@storybook/addon-interactions": "^7.4.4",
+    "@storybook/addon-links": "^7.4.4",
+    "@storybook/blocks": "^7.4.4",
+    "@storybook/react": "^7.4.4",
+    "@storybook/react-vite": "^7.4.4",
     "@storybook/testing-library": "^0.2.1",
     "@testing-library/react": "^14.0.0",
-    "@types/node": "^20.6.1",
-    "@types/react": "^18.2.21",
+    "@types/node": "^20.6.4",
+    "@types/react": "^18.2.22",
     "@types/react-dom": "^18.2.7",
-    "@typescript-eslint/parser": "^6.7.0",
-    "@vitest/coverage-v8": "^0.34.4",
-    "eslint": "^8.49.0",
+    "@typescript-eslint/parser": "^6.7.2",
+    "@vitest/coverage-v8": "^0.34.5",
+    "eslint": "^8.50.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.3",
-    "eslint-plugin-storybook": "^0.6.13",
+    "eslint-plugin-storybook": "^0.6.14",
     "jsdom": "^22.1.0",
     "prettier": "^3.0.3",
     "publint": "^0.2.2",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rollup": "^3.29.1",
+    "rollup": "^3.29.3",
     "rollup-plugin-dts": "^5.3.1",
-    "storybook": "^7.4.2",
+    "storybook": "^7.4.4",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2",
-    "vitest": "^0.34.4"
+    "vitest": "^0.34.5"
   },
   "peerDependencies": {
     "react": "^18.2.0",

@beautiful-tree/types/package.json

@@ -17,7 +17,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf dist && rollup --config rollup.config.prod.mjs",
+    "build": "../../scripts/build.sh types",
+    "build:ci": "rollup --config rollup.config.prod.mjs",
     "lint": "tsc && eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0 && publint",
     "lint:eslint": "eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0",
     "lint:publint": "publint",
@@ -30,12 +31,12 @@
     "@arethetypeswrong/cli": "^0.10.2",
     "@coderspirit/eslint-config": "^1.2.1",
     "@rollup/plugin-typescript": "^11.1.3",
-    "@types/node": "^20.6.1",
-    "@typescript-eslint/parser": "^6.7.0",
-    "eslint": "^8.49.0",
+    "@types/node": "^20.6.4",
+    "@typescript-eslint/parser": "^6.7.2",
+    "eslint": "^8.50.0",
     "prettier": "^3.0.3",
     "publint": "^0.2.2",
-    "rollup": "^3.29.1",
+    "rollup": "^3.29.3",
     "rollup-plugin-dts": "^5.3.1",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2"

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing Guidelines
+
+## Code of Conduct
+This project and everyone participating in it is governed by our
+[Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to
+uphold this code. Please report unacceptable behavior to
+[email protected].
+
+## How can I contribute?
+- Reporting bugs
+- Proposing new features or improvements
+  - For bug reports & proposals, consider the following:
+  - Always be respectful, and mind the [Code of Conduct](./CODE_OF_CONDUCT.md)
+  - Check if someone else already reported that bug or proposed that idea.
+  - Try to be thorough and detailed with your explanations, to help others to
+    understand them and take proper action.
+- Improving the current documentation
+- Contributing code
+  - Always be respectful, and mind the [Code of Conduct](./CODE_OF_CONDUCT.md)
+  - Backwards compatibility is almost sacred, please try to preserve it.
+  - Try to respect the current coding style, to avoid style inconsistencies.
+
+## Tooling
+
+1. If you are developing from a Macos system, it is advisable to install the
+   `findutils` package via `brew` (or your package manager of choice).
+2. To save time in CI and have more immediate feedback, it is a good idea to
+   enable the Git hooks with the command:
+   ```bash
+   pnpm install-githooks
+   ```
+
+## Code Contributions: Acceptance Criteria
+
+In order for us to accept contributions, the merge request must fulfill certain
+requirements:
+
+### Style Guide
+
+There is no "official" style guide, although we enforce style through automated
+tools, such as [Prettier](https://prettier.io/) and
+[ESLint](https://eslint.org/).
+
+### Commit signatures
+For security & regulations compliance, commits must be cryptographically signed
+by [PGP](https://www.openpgp.org/)/[GPG](https://gnupg.org/), or SSH
+([since git v2.34](https://github.blog/2021-11-15-highlights-from-git-2-34/)).
+You can read more about this topic here:
+  - [Git's documentation](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)
+  - [Github's documentation](https://help.github.com/en/github/authenticating-to-github/signing-commits)
+  - [Gitlab's documentation](https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/).
+  - [Signing Git commits with your SSH key](https://calebhearth.com/sign-git-with-ssh)
+
+### Commit messages
+
+Commit messages must be properly formatted (following the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) rules).
+The reasons behind this decision are many:
+  - The project's history has to be "easy" to read.
+  - It's easier to extract statistics from the commit logs.
+  - It's easier to generate useful changelogs.
+  - This practice enforces that committers think twice about the nature of their
+    contributions.
+  - It allows us to automate version numbering (following
+    [Semantic Versioning](https://semver.org/) rules)
+
+### Branch history
+
+The merge request's commits have to present a "clean" history, `git rebase` is
+your friend. This means:
+  - linear history
+  - commit messages matching what the commit does
+  - no "experimental" commits + their revert commits

package.json

@@ -1,10 +1,12 @@
 {
   "name": "beautiful-tree",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "private": true,
   "author": "Andres Correa Casablanca <[email protected]>",
   "license": "MIT",
   "scripts": {
-    "install-githooks": "if [ -d .git ]; then git config core.hooksPath .hooks; fi"
+    "build": "pnpm -r run build",
+    "install-githooks": "if [ -d .git ]; then git config core.hooksPath .hooks; fi",
+    "test": "pnpm -r run test"
   }
 }