terra-draw 0.0.1-alpha.3 → 0.0.1-alpha.30

package/package.json

@@ -1,88 +1,152 @@
 {
-    "name": "terra-draw",
-    "version": "0.0.1-alpha.3",
-    "description": "Frictionless map drawing across mapping provider",
-    "scripts": {
-        "build": "microbundle",
-        "watch": "microbundle --watch --format modern",
-        "test": "jest --config jest.config.ts",
-        "test:coverage": "jest --config jest.config.ts --coverage",
-        "test:nocheck": "NO_CHECK=true jest --config jest.config.ts",
-        "test:nocheck:coverage": "NO_CHECK=true jest --config jest.config.ts --coverage",
-        "lint": "eslint --ext .ts src/",
-        "lint:quiet": "eslint --ext .ts --quiet src/",
-        "lint:fix": "eslint --fix --ext .ts src/",
-        "lint:fix:quiet": "eslint --fix --quiet --ext .ts src/",
-        "prepare": "husky install"
-    },
-    "type": "module",
-    "source": "src/terra-draw.ts",
-    "exports": {
-        "require": "./dist/terra-draw.cjs",
-        "default": "./dist/terra-draw.modern.js",
-        "types": "./dist/terra-draw.d.ts"
-    },
-    "types": "./dist/foo.d.ts",
-    "main": "./dist/terra-draw.cjs",
-    "module": "./dist/terra-draw.module.js",
-    "unpkg": "./dist/terra-draw.umd.js",
-    "author": "James Milner",
-    "license": "MIT",
-    "repository": "JamesLMilner/terra-draw",
-    "devDependencies": {
-        "@commitlint/cli": "^17.1.2",
-        "@commitlint/config-conventional": "^17.1.0",
-        "@googlemaps/js-api-loader": "^1.14.3",
-        "@swc/jest": "^0.2.22",
-        "@types/geojson": "^7946.0.8",
-        "@types/google.maps": "^3.49.2",
-        "@types/jest": "^28.1.5",
-        "@types/leaflet": "^1.7.11",
-        "@types/mapbox-gl": "^2.7.3",
-        "@types/rbush": "^3.0.0",
-        "@typescript-eslint/eslint-plugin": "^5.38.1",
-        "@typescript-eslint/parser": "^5.38.1",
-        "eslint": "^8.24.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "husky": "^7.0.0",
-        "jest": "^28.1.2",
-        "leaflet": "^1.8.0",
-        "mapbox-gl": "^2.9.1",
-        "microbundle": "^0.15.0",
-        "serve": "^13.0.4",
-        "ts-jest": "^28.0.5",
-        "ts-loader": "^9.3.1",
-        "typescript": "^4.7.4"
-    },
-    "commitlint": {
-        "extends": [
-            "@commitlint/config-conventional"
-        ]
-    },
-    "eslintConfig": {
-        "parser": "@typescript-eslint/parser",
-        "plugins": [
-            "@typescript-eslint"
-        ],
-        "rules": {
-            "indent": [
-                "error",
-                4
-            ],
-            "semi": [
-                "error",
-                "always"
-            ],
-            "@typescript-eslint/no-empty-function": "warn"
-        },
-        "extends": [
-            "plugin:@typescript-eslint/recommended",
-            "prettier"
-        ]
-    },
-    "prettier": {
-        "printWidth": 80,
-        "semi": true
-    }
-}
+	"name": "terra-draw",
+	"version": "0.0.1-alpha.30",
+	"description": "Frictionless map drawing across mapping provider",
+	"scripts": {
+		"docs": "typedoc",
+		"docs:serve": "serve ./docs",
+		"release": "standard-version",
+		"build": "microbundle",
+		"watch": "microbundle --watch --format modern",
+		"test": "jest --config jest.config.ts",
+		"test:coverage": "jest --config jest.config.ts --coverage",
+		"test:nocheck": "NO_CHECK=true jest --config jest.config.ts",
+		"test:nocheck:coverage": "NO_CHECK=true jest --config jest.config.ts --coverage",
+		"lint": "eslint --ext .ts src/",
+		"lint:quiet": "eslint --ext .ts --quiet src/",
+		"lint:fix": "eslint --fix --ext .ts src/",
+		"lint:fix:quiet": "eslint --fix --quiet --ext .ts src/",
+		"format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
+		"format:quiet": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\" --loglevel=silent",
+		"prepare": "husky install"
+	},
+	"type": "module",
+	"source": "src/terra-draw.ts",
+	"exports": {
+		"types": "./dist/terra-draw.d.ts",
+		"require": "./dist/terra-draw.cjs",
+		"default": "./dist/terra-draw.modern.js"
+	},
+	"types": "./dist/terra-draw.d.ts",
+	"main": "./dist/terra-draw.cjs",
+	"module": "./dist/terra-draw.module.js",
+	"unpkg": "./dist/terra-draw.umd.js",
+	"author": "James Milner",
+	"license": "MIT",
+	"repository": "JamesLMilner/terra-draw",
+	"keywords": [
+		"map",
+		"drawing",
+		"draw",
+		"map drawing",
+		"geometry",
+		"leaflet",
+		"leafletjs",
+		"mapbox",
+		"mapboxgl",
+		"google maps",
+		"openlayers",
+		"maplibre"
+	],
+	"devDependencies": {
+		"@commitlint/cli": "^17.1.2",
+		"@commitlint/config-conventional": "^17.1.0",
+		"@googlemaps/js-api-loader": "^1.14.3",
+		"@swc/jest": "^0.2.24",
+		"@types/geojson": "^7946.0.8",
+		"@types/google.maps": "^3.49.2",
+		"@types/jest": "^28.1.5",
+		"@types/leaflet": "^1.7.11",
+		"@types/mapbox-gl": "^2.7.3",
+		"@types/rbush": "^3.0.0",
+		"@typescript-eslint/eslint-plugin": "^5.57.0",
+		"@typescript-eslint/parser": "^5.57.0",
+		"eslint": "^8.24.0",
+		"eslint-config-prettier": "^8.5.0",
+		"eslint-plugin-prettier": "^4.2.1",
+		"husky": "^7.0.0",
+		"jest": "^29.3.1",
+		"leaflet": "^1.8.0",
+		"mapbox-gl": "^2.13.0",
+		"maplibre-gl": "^2.4.0",
+		"microbundle": "^0.15.0",
+		"ol": "^7.1.0",
+		"serve": "^14.1.2",
+		"standard-version": "^9.5.0",
+		"ts-jest": "^29.0.3",
+		"ts-loader": "^9.4.2",
+		"typedoc": "^0.23.28",
+		"typescript": "^5.0.3"
+	},
+	"commitlint": {
+		"extends": [
+			"@commitlint/config-conventional"
+		]
+	},
+	"eslintConfig": {
+		"parser": "@typescript-eslint/parser",
+		"plugins": [
+			"@typescript-eslint"
+		],
+		"rules": {
+			"@typescript-eslint/no-empty-function": "warn"
+		},
+		"extends": [
+			"plugin:@typescript-eslint/recommended",
+			"prettier"
+		]
+	},
+	"prettier": {
+		"printWidth": 80,
+		"semi": true,
+		"useTabs": true
+	},
+	"standard-version": {
+		"types": [
+			{
+				"type": "feat",
+				"section": "Features"
+			},
+			{
+				"type": "fix",
+				"section": "Bug Fixes"
+			},
+			{
+				"type": "docs",
+				"section": "Documentation"
+			},
+			{
+				"type": "style",
+				"section": "Styling"
+			},
+			{
+				"type": "refactor",
+				"section": "Refactors"
+			},
+			{
+				"type": "perf",
+				"section": "Performance"
+			},
+			{
+				"type": "test",
+				"section": "Tests"
+			},
+			{
+				"type": "build",
+				"section": "Build System"
+			},
+			{
+				"type": "ci",
+				"section": "CI"
+			},
+			{
+				"type": "chore",
+				"section": "Chore"
+			},
+			{
+				"type": "revert",
+				"section": "Reverts"
+			}
+		]
+	}
+}

package/scratch/release.sh

@@ -0,0 +1,6 @@
+npm run docs
+
+npm run build
+npm run release -- --prerelease --release-as 0.0.1-alpha.30
+git push origin main --tags
+npm publish

package/tsconfig.json

@@ -1,14 +1,22 @@
 {
-  "compilerOptions": {
-    "outDir": "./dist/",
-    "strict": true,
-    "noImplicitAny": true,
-    "module": "es6",
-    "target": "es6",
-    "jsx": "react",
-    "sourceMap": true,
-    "allowJs": true,
-    "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true
-  }
+	"compilerOptions": {
+		"outDir": "./dist/",
+		"strict": true,
+		"module": "es6",
+		"target": "es6",
+		"jsx": "react",
+		"sourceMap": true,
+		"allowJs": true,
+		"moduleResolution": "node",
+		"allowSyntheticDefaultImports": true
+	},
+	"typedocOptions": {
+		"entryPoints": ["src/terra-draw.ts"],
+		"exclude": ["src/geometry/**/*.ts", "src/test/**/*.ts", "src/util/**/*.ts"],
+		"out": "docs",
+		"skipErrorChecking": true
+		// "compilerOptions": {
+		//     "skipLibCheck": true
+		// }
+	}
 }

package/DEVELOPMENT.md

@@ -1,77 +0,0 @@
-# Development
-
-This file acts as a way to document how to develop the Terra Draw project locally. 
-
-### Prerequisites
-
-A few things you will need to have installed in order to develop on this project:
-
-* git
-* Node LTS - currently v16
-* npm 8 
-
-### Folder Structure
-
-
-* `.github` - used for all GitHub related configuration such as the GitHub Actions work flows
-* `.husky` - used to storing the precommit hooks that are used on the project
-* `src` - source files for the project
-* `dist` - the bundled distributed files of the project
-* `docs` - the demo app that is published to GitHub pages
-* `development` - the local development app that is used for developing locally (see below)
-* `common` - code that is used across `development` and `docs` folder`
-
-### Technologies Used
-
-Terra Draw 
-
-* [TypeScript](https://www.typescriptlang.org/) - provides strong compile time typing for JavaScript
-* Jest - used for testing (see more information below)
-* microbundle - used for the production bundle
-* Webpack - used for bundling locally in development (`development` and `docs` folders)
-* esno - for running tests quickly without type checking
-
-### Precommit Hooks
-
-It is probably useful to be aware of the precommit hooks you will face when trying to run a git commit on the project. There are two currently in use, namely:
-
-* Uses pre-commit hook to run lint rules (eslint/prettier) on code before commit
-* Uses pre-commit hook to ensure [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/) are used 
-
-### Testing
-
-Terra Draw uses [jest](https://jestjs.io/) as it's testing framework. You can distinguish a test by it's `.spec.ts` prefix on the file name.  
-
-To run the tests as they would run in CI:
-
-```
-npm run test
-```
-
-You can also check the coverage by running:
-
-
-```
-npm run test:coverage
-```
-
-For local development you may benefit from the `nocheck` option which allows you to avoid running TypeScript type checking when running the tests. This option also only checks files which are explicitly tested (i.e. have a spec file.)
-
-```
-npm run test:nocheck
-npm run test:nocheck:coverage
-```
-
-### Developing Locally
-
-A folder called `development` has been set up locally to allow you to test developing Terra Draw locally more easily. It allows you to run the different adapters and test different map providers in parallel, ensuring. You will need to update the .env file in the `development` folder in order to use the related adapters working. An example `.env` file in the `development` folder:
-
-
-```
-GOOGLE_API_KEY=YOUR_KEY_HERE
-MAPBOX_ACCESS_TOKEN=YOUR_KEY_HERE
-```
-
-### GitHub Pages Example
-
-We also provide a GitHub Pages example that can developed on in the `docs` folder. This automatically deploys from the `main` branch.