diff --git a/docs/plugins/adjust/README.md b/docs/plugins/adjust/README.md index 2983b0db0..aa186b40e 100644 --- a/docs/plugins/adjust/README.md +++ b/docs/plugins/adjust/README.md @@ -1,9 +1,9 @@ - + Improve this doc -# AdjustThirdPartySharing -on +# AdjustEvent +toreSubscription plugin add com.adjust.sdk $ npm install @ionic-native/plugins/adjust ``` diff --git a/docs/plugins/hyper-track/README.md b/docs/plugins/hyper-track/README.md index 4e7249ce7..bccac9f3d 100644 --- a/docs/plugins/hyper-track/README.md +++ b/docs/plugins/hyper-track/README.md @@ -1,8 +1,8 @@ - + Improve this doc -# Coordinates +# HyperTrack alidationError ic cordova plugin add cordova-plugin-hypertrack-v3 $ npm install @ionic-native/plugins/hyper-track diff --git a/docs/plugins/metrix/README.md b/docs/plugins/metrix/README.md index 9b47a2c94..1f9c33d58 100644 --- a/docs/plugins/metrix/README.md +++ b/docs/plugins/metrix/README.md @@ -1,9 +1,10 @@ - + Improve this doc -# MetrixConfig +# Metrix +``` $ ionic cordova plugin add ir.metrix.sdk $ npm install @ionic-native/plugins/metrix ``` diff --git a/docs/plugins/smartlook/README.md b/docs/plugins/smartlook/README.md index e65b355dc..12744cd74 100644 --- a/docs/plugins/smartlook/README.md +++ b/docs/plugins/smartlook/README.md @@ -1,9 +1,11 @@ - + Improve this doc -# SmartlookTimedCustomEventStart -plugin add https://github.com/smartlook/cordova-smartlook.git +# Smartlook + +``` +$ ionic cordova plugin add https://github.com/smartlook/cordova-smartlook.git $ npm install @ionic-native/plugins/smartlook ``` diff --git a/docs/plugins/unvired-cordova-sdk/README.md b/docs/plugins/unvired-cordova-sdk/README.md index 50892fb8c..d6d7e0b3e 100644 --- a/docs/plugins/unvired-cordova-sdk/README.md +++ b/docs/plugins/unvired-cordova-sdk/README.md @@ -1,9 +1,11 @@ - + Improve this doc -# AuthenticateActivateResult -ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk +# Unvired Cordova SDK + +``` +$ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk $ npm install @ionic-native/plugins/unvired-cordova-sdk ``` diff --git a/package-lock.json b/package-lock.json index 1e1f2fe76..a5a8d8433 100644 --- a/package-lock.json +++ b/package-lock.json @@ -50,7 +50,6 @@ "terser-webpack-plugin": "^5.2.4", "ts-jest": "^27.0.5", "ts-node": "^10.2.1", - "typedoc": "^0.22.4", "typescript": "~4.1.6", "unminified-webpack-plugin": "^3.0.0", "webpack": "^5.55.0", @@ -10071,12 +10070,6 @@ "node": ">=6" } }, - "node_modules/jsonc-parser": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", - "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", - "dev": true - }, "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -10974,12 +10967,6 @@ "node": ">=10" } }, - "node_modules/lunr": { - "version": "2.3.9", - "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", - "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true - }, "node_modules/magic-string": { "version": "0.25.7", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.7.tgz", @@ -12773,30 +12760,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/onigasm": { - "version": "2.2.5", - "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", - "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", - "dev": true, - "dependencies": { - "lru-cache": "^5.1.1" - } - }, - "node_modules/onigasm/node_modules/lru-cache": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", - "dev": true, - "dependencies": { - "yallist": "^3.0.2" - } - }, - "node_modules/onigasm/node_modules/yallist": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", - "dev": true - }, "node_modules/optionator": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", @@ -14163,17 +14126,6 @@ "node": ">=0.11.0" } }, - "node_modules/shiki": { - "version": "0.9.11", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.11.tgz", - "integrity": "sha512-tjruNTLFhU0hruCPoJP0y+B9LKOmcqUhTpxn7pcJB3fa+04gFChuEmxmrUfOJ7ZO6Jd+HwMnDHgY3lv3Tqonuw==", - "dev": true, - "dependencies": { - "jsonc-parser": "^3.0.0", - "onigasm": "^2.2.5", - "vscode-textmate": "5.2.0" - } - }, "node_modules/signal-exit": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.4.tgz", @@ -15706,60 +15658,6 @@ "is-typedarray": "^1.0.0" } }, - "node_modules/typedoc": { - "version": "0.22.4", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.4.tgz", - "integrity": "sha512-M/a8NnPxq3/iZNNVjzFCK5gu4m//HTJIPbSS0JQVbkHJPP9wyepR12agylWTSqeVZe0xsbidVtO26+PP7iD/jw==", - "dev": true, - "dependencies": { - "glob": "^7.1.7", - "lunr": "^2.3.9", - "marked": "^3.0.4", - "minimatch": "^3.0.4", - "shiki": "^0.9.11" - }, - "bin": { - "typedoc": "bin/typedoc" - }, - "engines": { - "node": ">= 12.10.0" - }, - "peerDependencies": { - "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x" - } - }, - "node_modules/typedoc/node_modules/glob": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", - "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", - "dev": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/typedoc/node_modules/marked": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.4.tgz", - "integrity": "sha512-jBo8AOayNaEcvBhNobg6/BLhdsK3NvnKWJg33MAAPbvTWiG4QBn9gpW1+7RssrKu4K1dKlN+0goVQwV41xEfOA==", - "dev": true, - "bin": { - "marked": "bin/marked" - }, - "engines": { - "node": ">= 12" - } - }, "node_modules/typescript": { "version": "4.1.6", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.1.6.tgz", @@ -16151,12 +16049,6 @@ "node": ">=0.10.0" } }, - "node_modules/vscode-textmate": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", - "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", - "dev": true - }, "node_modules/w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", @@ -24475,12 +24367,6 @@ "minimist": "^1.2.5" } }, - "jsonc-parser": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", - "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", - "dev": true - }, "jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -25176,12 +25062,6 @@ "yallist": "^4.0.0" } }, - "lunr": { - "version": "2.3.9", - "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", - "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true - }, "magic-string": { "version": "0.25.7", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.7.tgz", @@ -26615,32 +26495,6 @@ "mimic-fn": "^2.1.0" } }, - "onigasm": { - "version": "2.2.5", - "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", - "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", - "dev": true, - "requires": { - "lru-cache": "^5.1.1" - }, - "dependencies": { - "lru-cache": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", - "dev": true, - "requires": { - "yallist": "^3.0.2" - } - }, - "yallist": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", - "dev": true - } - } - }, "optionator": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", @@ -27677,17 +27531,6 @@ "rechoir": "^0.6.2" } }, - "shiki": { - "version": "0.9.11", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.11.tgz", - "integrity": "sha512-tjruNTLFhU0hruCPoJP0y+B9LKOmcqUhTpxn7pcJB3fa+04gFChuEmxmrUfOJ7ZO6Jd+HwMnDHgY3lv3Tqonuw==", - "dev": true, - "requires": { - "jsonc-parser": "^3.0.0", - "onigasm": "^2.2.5", - "vscode-textmate": "5.2.0" - } - }, "signal-exit": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.4.tgz", @@ -28890,41 +28733,6 @@ "is-typedarray": "^1.0.0" } }, - "typedoc": { - "version": "0.22.4", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.4.tgz", - "integrity": "sha512-M/a8NnPxq3/iZNNVjzFCK5gu4m//HTJIPbSS0JQVbkHJPP9wyepR12agylWTSqeVZe0xsbidVtO26+PP7iD/jw==", - "dev": true, - "requires": { - "glob": "^7.1.7", - "lunr": "^2.3.9", - "marked": "^3.0.4", - "minimatch": "^3.0.4", - "shiki": "^0.9.11" - }, - "dependencies": { - "glob": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", - "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", - "dev": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "marked": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.4.tgz", - "integrity": "sha512-jBo8AOayNaEcvBhNobg6/BLhdsK3NvnKWJg33MAAPbvTWiG4QBn9gpW1+7RssrKu4K1dKlN+0goVQwV41xEfOA==", - "dev": true - } - } - }, "typescript": { "version": "4.1.6", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.1.6.tgz", @@ -29246,12 +29054,6 @@ } } }, - "vscode-textmate": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", - "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", - "dev": true - }, "w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", diff --git a/package.json b/package.json index 829b58056..58794c0bf 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,6 @@ "terser-webpack-plugin": "^5.2.4", "ts-jest": "^27.0.5", "ts-node": "^10.2.1", - "typedoc": "^0.22.4", "typescript": "~4.1.6", "unminified-webpack-plugin": "^3.0.0", "webpack": "^5.55.0", diff --git a/scripts/docs-json/index.ts b/scripts/docs-json/index.ts deleted file mode 100644 index 2c1b9c48d..000000000 --- a/scripts/docs-json/index.ts +++ /dev/null @@ -1,127 +0,0 @@ -import { outputJson, readdir, readJson } from 'fs-extra'; -import { basename, dirname, resolve } from 'path'; -import { Application } from 'typedoc'; -import TypeDoc = require('typedoc'); -import { runInNewContext } from 'vm'; - -interface Plugin { - packageName: string; - displayName: string; - description: string; - platforms: string[]; - usage: string; - repo: string; - installVariables: string[]; - cordovaPlugin: { - name: string; - }; - premierSlug: string; - capacitorIncompatible: boolean; -} - -const rootDir = resolve(__dirname, '../..'); -const typedocDocsTmp = resolve(__dirname, 'typedoc-docs'); -const typedocTmp = resolve(__dirname, 'typedoc.tmp.json'); -const pluginsDir = resolve(rootDir, 'src/@awesome-cordova-plugins/plugins'); -const typedoc = new Application(); - -typedoc.options.addReader(new TypeDoc.TSConfigReader()); -typedoc.options.addReader(new TypeDoc.TypeDocReader()); - -run(pluginsDir); - -async function run(pluginsDir: string) { - try { - const typedocData = await generateTypedoc(pluginsDir); - const modules = typedocData.children.filter(isModule); - const plugins = modules.filter(hasPlugin).map(processPlugin); - await outputJson(resolve(__dirname, 'plugins.json'), plugins, { - spaces: 2, - }); - } catch (e) { - console.error('Unable to generate typedoc', e); - } -} - -async function generateTypedoc(root: string, outputPath = typedocTmp, outputDocsPath = typedocDocsTmp) { - const pluginDirs = await readdir(root); - const paths = pluginDirs.map((dir) => resolve(root, dir, 'index.ts')); - typedoc.bootstrap({ - /* - mode: 'modules', - ignoreCompilerErrors: true, - */ - entryPoints: paths, - tsconfig: `tsconfig.json`, - }); - const project = typedoc.converter.convert(typedoc.getEntryPoints() ?? []); - - await typedoc.generateDocs(project, outputDocsPath); - await typedoc.generateJson(project, outputPath); - - return readJson(outputPath); -} - -function processPlugin(pluginModule): Plugin { - const pluginClass = pluginModule.children.find(isPlugin); - console.log(pluginClass); - const decorator = getPluginDecorator(pluginClass); - const packageName = `@awesome-cordova-plugins/${basename(dirname(pluginModule.originalName))}`; - const displayName = getTag(pluginClass, 'name'); - const usage = getTag(pluginClass, 'usage'); - const description = getTag(pluginClass, 'description'); - const premierSlug = getTag(pluginClass, 'premier'); - const capIncompat = getTag(pluginClass, 'capacitorincompatible'); - const capacitorIncompatible = capIncompat ? true : undefined; - return { - packageName, - displayName, - description, - usage, - platforms: decorator.platforms, - repo: decorator.repo, - installVariables: decorator.installVariables, - cordovaPlugin: { - name: decorator.plugin, - }, - premierSlug, - capacitorIncompatible, - }; -} - -/** - * Typedoc only gives us the Plugin decorator internals - * as a string. So, rather than try to parse that with a RegExp, - * we evaluate it using Node's vm module. - */ -const getPluginDecorator = (child: any) => { - if (isPlugin(child)) { - const decorator = child.decorators.find((d) => d.name === 'Plugin'); - - console.log('Found decorator', decorator.arguments, child); - return runInNewContext(`(${decorator.arguments.config})`); - } -}; - -const getTag = (child: any, tagName: string): string => { - if (hasTags(child)) { - const tag = child.comment.tags.find((t) => t.tag === tagName); - if (tag) { - return tag.text; - } - } -}; - -const isModule = (child: any): boolean => child.kind === 1; - -const isClass = (child: any): boolean => child.kind === 128; - -const isPlugin = (child: any): boolean => - isClass(child) && - hasTags(child) && - Array.isArray(child.decorators) && - child.decorators.some((d) => d.name === 'Plugin'); - -const hasPlugin = (child: any): boolean => child.children.some(isPlugin); - -const hasTags = (child: any): boolean => child.comment && Array.isArray(child.comment.tags); diff --git a/scripts/docs-json/readme.md b/scripts/docs-json/readme.md deleted file mode 100644 index 6918b02e9..000000000 --- a/scripts/docs-json/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# docs-json - -This script reads and generates [typedoc](https://github.com/TypeStrong/typedoc) data for each of the plugins in `src/@awesome-cordova-plugins/plugins`. That data is then formatted and output as `plugins.json` in this directory. diff --git a/scripts/git/clone.sh b/scripts/git/clone.sh deleted file mode 100755 index a2b0e551e..000000000 --- a/scripts/git/clone.sh +++ /dev/null @@ -1,30 +0,0 @@ -#!/bin/bash - -ARG_DEFS=( - "--repository=(.*)" - "--directory=(.*)" - "[--depth=(.*)]" - "[--branch=(.*)]" -) - -function run { - rm -rf $DIRECTORY - mkdir -p $DIRECTORY - - echo "-- Cloning $REPOSITORY#$BRANCH to $DIRECTORY..." - - ARGS="--branch=${BRANCH:-master} --depth=3" - if [[ "$DEPTH" != "" ]]; then - ARGS="$ARGS --depth=$DEPTH" - fi - - git config --global user.email "hi@ionicframework.com" - git config --global user.name "Ionitron" - - git clone git@github.com:ionic-team/$REPOSITORY.git $DIRECTORY $ARGS - cd $DIRECTORY - git fetch origin --tags - cd ../ -} - -source $(dirname $0)/../utils.inc.sh diff --git a/scripts/git/config.sh b/scripts/git/config.sh deleted file mode 100644 index 3221b0c64..000000000 --- a/scripts/git/config.sh +++ /dev/null @@ -1,2 +0,0 @@ -git config --global user.email "hi@ionicframework.com" -git config --global user.name "Ionitron"