Release v0.1.0 (#7)

* refactor: remove currentPass from default function

* chore: improve prettierrc setup

* chore: update readme

* chore: update version

* chore: Add minify option to tsup.config.ts

* chore: Update branch restrictions for unit tests workflow

* chore: update readme

* chore: add eslint and remove unused dependencies

* chore: run lint and format

* chore: update version to v0.1.0

.eslintignore

@@ -0,0 +1,9 @@
+.DS_Store
+node_modules
+/dist
+.env
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

.eslintrc.cjs

@@ -0,0 +1,15 @@
+module.exports = {
+	root: true,
+	extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+	parser: '@typescript-eslint/parser',
+	plugins: ['@typescript-eslint'],
+	parserOptions: {
+		sourceType: 'module',
+		ecmaVersion: 2020
+	},
+	env: {
+		browser: true,
+		es2017: true,
+		node: true
+	}
+};

.github/workflows/unit-tests.yml

@@ -2,7 +2,7 @@ name: Run unit tests
 
 on:
   push:
-    branches: [main]
+    branches: [develop, main]
   pull_request:
     branches: [develop, main]
 

.npmignore

@@ -1,10 +1,7 @@
 /src
 /node_modules
-
 .env
 .DS_Store
-
 tsconfig.json
 tsup.config.js
-
 NOTES.md

.prettierrc

@@ -1,5 +1,6 @@
 {
 	"useTabs": true,
+	"tabWidth": 2,
 	"singleQuote": true,
 	"trailingComma": "none",
 	"printWidth": 100

.vscode/settings.json

@@ -8,7 +8,8 @@
 		"mutipolygons",
 		"polyunion",
 		"rbush",
-		"tsup"
+		"tsup",
+		"turfjs"
 	],
 	"githubPullRequests.ignoredPullRequestBranches": ["develop"]
 }

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 # PolyUnion Changelog
 
+## v0.1.0 (2024-03-03)
+
+The code is stable enough for use and I'm proud to release it as v0.1.0 🤣. Will improve along with more tests as needed.
+
+### Refactors & Improvements ✨
+
+- Removed some unnecessary dependencies
+- Added eslint
+- Implemented minification on build
+- Simplified function by removing unnecessary parameters
+
 ## v0.0.2 (2024-03-03)
 
 ### Refactors & Improvements ✨

README.md

@@ -1,6 +1,6 @@
 # PolyUnion
 
-A fast and efficient js utility function designed for merging multiple polygons within a GeoJSON FeatureCollection. It utilizes spatial indexing provided by rbush and the geospatial processing of Turf to achieve high performance.
+A fast and efficient js utility function designed for merging multiple polygons within a GeoJSON FeatureCollection. It utilizes spatial indexing provided by **[rbush](https://github.com/mourner/rbush)** and the geospatial processing of **[Turfjs](https://github.com/Turfjs/turf)** to achieve high performance.
 
 ## Performance
 
@@ -50,11 +50,7 @@ const mergedFeatureCollection = polyunion(features);
 console.log(mergedFeatureCollection);
 ```
 
-The function has 3 parameters:
+The function has 2 parameters:
 
 - `featureCollection` (required): A GeoJSON FeatureCollection containing polygons to merge.
-- `currentPass` (optional, default: 1): The current pass number. This is used internally for recursive calls and should not be set manually.
-- `totalPasses` (optional, default: 3): The total number of passes for internal use in recursive calls. This parameter should not be set manually. The larger the number of iterations, the better the results, but the function will run slower. It depends on the number of polygons being merged. For the case above, 3 passes worked grat.
-
-Feel free to adjust or expand upon this section as needed!
-
+- `totalPasses` (optional, defaults to 3): The total number of passes for internal use in recursive calls. The larger the number of iterations, the better the results, but the function will run slower. It depends on the number of polygons being merged. For the case in the picture above, 4 passes worked great.