From a21470f6b4204de2119e205d704b07c622502c2a Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Sat, 4 Apr 2020 10:55:43 +0200 Subject: [PATCH 1/5] Merge pull request #10872 from ahocevar/fix-type-generation Use TypeScript 3.9 for type generation for better enums --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f7fefb945c..8c59997158 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "build-index": "npm run build-package && node tasks/generate-index", "build-legacy": "shx rm -rf build && npm run build-index && webpack --config config/webpack-config-legacy-build.js && cleancss --source-map src/ol/ol.css -o build/legacy/ol.css", "copy-css": "shx cp src/ol/ol.css build/ol/ol.css", - "transpile": "shx rm -rf build/ol && shx mkdir -p build/ol && shx cp -rf src/ol build/ol/src && node tasks/serialize-workers && npx --package typescript@3.8.1-rc tsc --project config/tsconfig-build.json", + "transpile": "shx rm -rf build/ol && shx mkdir -p build/ol && shx cp -rf src/ol build/ol/src && node tasks/serialize-workers && npx --package typescript@3.9.0-dev.20200403 tsc --project config/tsconfig-build.json", "typecheck": "tsc --pretty", "apidoc-debug": "shx rm -rf build/apidoc && node --inspect-brk=9229 ./node_modules/jsdoc/jsdoc.js -R config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc", "apidoc": "shx rm -rf build/apidoc && jsdoc -R config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc" From afa96df55dff69366a6874d649cd8d3afc0342ce Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Sun, 5 Apr 2020 08:37:27 +0200 Subject: [PATCH 2/5] Merge pull request #10877 from ahocevar/no-dts Remove .d.ts files from the package --- README.md | 25 +++++++++++++++++++++++++ config/tsconfig-build.json | 4 ++-- package.json | 2 +- 3 files changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c789b6835..dd54fb0ed9 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,31 @@ OpenLayers appreciates contributions of all kinds. We especially want to thank See our [Open Collective](https://opencollective.com/openlayers/contribute/sponsors-214/checkout) page if you too are interested in becoming a regular sponsor. +## IntelliSense support and type checking for VS Code + +The ol package contains a src/ folder with JSDoc annotated sources. TypeScript can get type definitions from these sources with a `jsconfig.json` config file in the project root: + +```json +{ + "compilerOptions": { + "checkJs": true, + "baseUrl": "./", + "paths": { + "ol": ["node_modules/ol/src"], + "ol/*": ["node_modules/ol/src/*"] + } + }, + "include": [ + "**/*.js", + "node_modules/ol/**/*.js" + ] +} +``` + +Project template with this configuration: https://gist.github.com/9a7253cb4712e8bf38d75d8ac898e36c. + +Note that the above only works when authoring in plain JavaScript. For similar configurations with a `tsconfig.json` in TypeScript projects, your mileage may vary. You may want to use a [third-party types package](https://github.com/hanreev/types-ol) in this case. + ## Supported Browsers OpenLayers runs on all modern browsers that support [HTML5](https://html.spec.whatwg.org/multipage/) and [ECMAScript 5](http://www.ecma-international.org/ecma-262/5.1/). This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, [polyfills](http://polyfill.io) for `requestAnimationFrame` and `Element.prototype.classList` are required, and using the KML format requires a polyfill for `URL`. diff --git a/config/tsconfig-build.json b/config/tsconfig-build.json index f5a8720329..56de194321 100644 --- a/config/tsconfig-build.json +++ b/config/tsconfig-build.json @@ -7,8 +7,8 @@ "allowJs": true, /* Allow javascript files to be compiled. */ // "checkJs": true, /* Report errors in .js files. */ // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ - "declaration": true, /* Generates corresponding '.d.ts' file. */ - "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ "sourceMap": true, /* Generates corresponding '.map' file. */ // "outFile": "./", /* Concatenate and emit output to single file. */ "outDir": "../build/ol", /* Redirect output structure to the directory. */ diff --git a/package.json b/package.json index 8c59997158..a2930cc3e3 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "build-index": "npm run build-package && node tasks/generate-index", "build-legacy": "shx rm -rf build && npm run build-index && webpack --config config/webpack-config-legacy-build.js && cleancss --source-map src/ol/ol.css -o build/legacy/ol.css", "copy-css": "shx cp src/ol/ol.css build/ol/ol.css", - "transpile": "shx rm -rf build/ol && shx mkdir -p build/ol && shx cp -rf src/ol build/ol/src && node tasks/serialize-workers && npx --package typescript@3.9.0-dev.20200403 tsc --project config/tsconfig-build.json", + "transpile": "shx rm -rf build/ol && shx mkdir -p build/ol && shx cp -rf src/ol build/ol/src && node tasks/serialize-workers && tsc --project config/tsconfig-build.json", "typecheck": "tsc --pretty", "apidoc-debug": "shx rm -rf build/apidoc && node --inspect-brk=9229 ./node_modules/jsdoc/jsdoc.js -R config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc", "apidoc": "shx rm -rf build/apidoc && jsdoc -R config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc" From 6704cf3aced4eab3eca8306c5f0b017fbb1dcdc8 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Mon, 6 Apr 2020 09:11:58 +0200 Subject: [PATCH 3/5] Changelog for v6.3.1 --- changelog/v6.3.1.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 changelog/v6.3.1.md diff --git a/changelog/v6.3.1.md b/changelog/v6.3.1.md new file mode 100644 index 0000000000..8d814d125a --- /dev/null +++ b/changelog/v6.3.1.md @@ -0,0 +1,9 @@ +# 6.3.1 + +This is a bugfix release which removes the auto-generated `.d.ts` TypeScript type files from the published package. + +## List of all changes + + * [#10877](https://github.com/openlayers/openlayers/pull/10877) - Remove .d.ts files from the package ([@ahocevar](https://github.com/ahocevar)) + * [#10872](https://github.com/openlayers/openlayers/pull/10872) - Use TypeScript 3.9 for type generation for better enums ([@ahocevar](https://github.com/ahocevar)) + From af9f26b9d343e5496ea44a729265c4002616b240 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Mon, 6 Apr 2020 09:15:48 +0200 Subject: [PATCH 4/5] Update package version for 6.3.1 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 43de8147d9..2429cfc732 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "ol", - "version": "6.3.1-dev", + "version": "6.3.1", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index a2930cc3e3..a14d7e89cc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ol", - "version": "6.3.1-dev", + "version": "6.3.1", "description": "OpenLayers mapping library", "keywords": [ "map", From 347159d5fdf4fb9bee87371cd6409426212be756 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Mon, 6 Apr 2020 09:20:14 +0200 Subject: [PATCH 5/5] Develop on 6.3.2-dev --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 2429cfc732..790ac2a44a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "ol", - "version": "6.3.1", + "version": "6.3.2-dev", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index a14d7e89cc..9768e344a9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ol", - "version": "6.3.1", + "version": "6.3.2-dev", "description": "OpenLayers mapping library", "keywords": [ "map",