From 973f2dc0c136db62ade9b8be93cef53acf244ca6 Mon Sep 17 00:00:00 2001 From: Christian Bewernitz Date: Sat, 4 Sep 2021 18:01:33 +0200 Subject: [PATCH] test: Add executable example for Typescript (using ES6) --- .github/workflows/examples.yml | 30 +++++++++ examples/typescript/.gitignore | 3 + examples/typescript/.npmrc | 1 + examples/typescript/package.json | 22 +++++++ examples/typescript/pretest.sh | 10 +++ examples/typescript/src/index.ts | 14 +++++ examples/typescript/tsconfig.json | 100 ++++++++++++++++++++++++++++++ 7 files changed, 180 insertions(+) create mode 100644 examples/typescript/.gitignore create mode 100644 examples/typescript/.npmrc create mode 100644 examples/typescript/package.json create mode 100755 examples/typescript/pretest.sh create mode 100644 examples/typescript/src/index.ts create mode 100644 examples/typescript/tsconfig.json diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 1b9ffa341..137767912 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -30,3 +30,33 @@ jobs: working-directory: examples/nodejs - run: npm run test working-directory: examples/nodejs + typescript: + + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: + - 10 + - 12 + - 14 + - 16 + ts-version: + - 3.8 + - 3.9 + - 4 + + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + - run: ./pretest.sh ${{ matrix.ts-version }} + working-directory: examples/typescript + - run: node --experimental-modules dist/index.js + if: ${{ matrix.node-version == 12 }} + working-directory: examples/typescript + - run: node dist/index.js + if: ${{ matrix.node-version > 12 }} + working-directory: examples/typescript diff --git a/examples/typescript/.gitignore b/examples/typescript/.gitignore new file mode 100644 index 000000000..91a3983f3 --- /dev/null +++ b/examples/typescript/.gitignore @@ -0,0 +1,3 @@ +dist +node_modules +package-lock.json diff --git a/examples/typescript/.npmrc b/examples/typescript/.npmrc new file mode 100644 index 000000000..43c97e719 --- /dev/null +++ b/examples/typescript/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/examples/typescript/package.json b/examples/typescript/package.json new file mode 100644 index 000000000..e2718049f --- /dev/null +++ b/examples/typescript/package.json @@ -0,0 +1,22 @@ +{ + "name": "@xmldom/xmldom-example-typescript", + "private": true, + "description": "", + "main": "index.js", + "type": "module", + "scripts": { + "tsc": "tsc", + "test": "node dist/index.js" + }, + "keywords": [ + "test", + "typescript" + ], + "license": "MIT", + "devDependencies": { + "typescript": "^3.9.10" + }, + "dependencies": { + "@xmldom/xmldom": "file:../.." + } +} diff --git a/examples/typescript/pretest.sh b/examples/typescript/pretest.sh new file mode 100755 index 000000000..bb1ccd3d6 --- /dev/null +++ b/examples/typescript/pretest.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +set -eu + +rm -rf node_modules dist + +npm i +[[ ${1:-''} ]] \ + && npm i -D typescript@${1} --no-save \ + || echo "Using TypeScript $(node_modules/.bin/tsc --version) (change with first argument)" +npm run tsc diff --git a/examples/typescript/src/index.ts b/examples/typescript/src/index.ts new file mode 100644 index 000000000..bb3792485 --- /dev/null +++ b/examples/typescript/src/index.ts @@ -0,0 +1,14 @@ +import {DOMParser, XMLSerializer} from '@xmldom/xmldom'; + +const source = ` + test + +` + +const doc = new DOMParser().parseFromString(source, 'text/xml') + +const serialized = new XMLSerializer().serializeToString(doc) + +if (source !== serialized) { + throw `expected\n${source}\nbut was\n${serialized}` +} diff --git a/examples/typescript/tsconfig.json b/examples/typescript/tsconfig.json new file mode 100644 index 000000000..0a80aa7cd --- /dev/null +++ b/examples/typescript/tsconfig.json @@ -0,0 +1,100 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Projects */ + // "incremental": true, /* Enable incremental compilation */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + "lib": ["ES5"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */ + // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + + /* Modules */ + "module": "ES2020", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "resolveJsonModule": true, /* Enable importing .json files */ + // "noResolve": true, /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */ + // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */ + // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}