(identity: T) => identity
38 | }
39 | console.log(`${chalkWrapper(type.padStart(7))} ${message}`)
40 | }
41 | return log
42 | }
43 |
--------------------------------------------------------------------------------
/src/scripts/util/yarnAvailable.ts:
--------------------------------------------------------------------------------
1 | import { execSync } from 'child_process'
2 |
3 | export function yarnAvailable() {
4 | try {
5 | execSync('yarnpkg --version', { stdio: 'ignore' })
6 | return true
7 | } catch (e) {
8 | return false
9 | }
10 | }
11 |
--------------------------------------------------------------------------------
/src/types/TNS.ts:
--------------------------------------------------------------------------------
1 | export interface TNSOptions {
2 | noCollapse: boolean
3 | noAutoStart: boolean
4 | useMonorepo: boolean
5 | bypassCiWarnings: boolean
6 | }
7 |
--------------------------------------------------------------------------------
/src/util/env.ts:
--------------------------------------------------------------------------------
1 | import { TNSOptions } from '../types/TNS'
2 |
3 | const { argv } = process
4 |
5 | export const TNS_ARGUMENTS = {
6 | MONOREPO: '--monorepo',
7 | NO_COLLAPSE: '--no-collapse',
8 | NO_AUTO_STATRT: '--no-auto-start',
9 | BYPASS_CI_WARNINGS: '--bypass-ci-warnings',
10 | }
11 |
12 | export const RuntimeOptions: TNSOptions = {
13 | useMonorepo: !!~argv.indexOf(TNS_ARGUMENTS.MONOREPO),
14 | noCollapse: !!~argv.indexOf(TNS_ARGUMENTS.NO_COLLAPSE),
15 | noAutoStart: !!~argv.indexOf(TNS_ARGUMENTS.NO_AUTO_STATRT),
16 | bypassCiWarnings: !!~argv.indexOf(TNS_ARGUMENTS.BYPASS_CI_WARNINGS),
17 | }
18 |
19 | export const IS_CI =
20 | process.env.CI &&
21 | (typeof process.env.CI !== 'string' ||
22 | process.env.CI.toLowerCase() !== 'false')
23 |
24 | export const IS_INTERACTIVE = process.stdout.isTTY
25 |
--------------------------------------------------------------------------------
/src/util/platform.ts:
--------------------------------------------------------------------------------
1 | import * as os from 'os'
2 |
3 | export function isWindows() {
4 | return os.platform() === 'win32'
5 | }
6 |
--------------------------------------------------------------------------------
/template/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "parser": "@babel/eslint-parser",
3 | "extends": [
4 | "eslint:recommended"
5 | ],
6 | "plugins": [
7 | "import"
8 | ],
9 | "env": {
10 | "browser": false,
11 | "node": true,
12 | "jest": true,
13 | "es6": true
14 | },
15 | "parserOptions": {
16 | "ecmaVersion": 2018,
17 | "sourceType": "module",
18 | "requireConfigFile": false
19 | },
20 | "overrides": [
21 | {
22 | "files": [
23 | "**/*.ts"
24 | ],
25 | "parser": "@typescript-eslint/parser",
26 | "parserOptions": {
27 | "ecmaVersion": 2018,
28 | "sourceType": "module",
29 | "warnOnUnsupportedTypeScriptVersion": true,
30 | "project": "./tsconfig.json"
31 | },
32 | "extends": [
33 | "plugin:@typescript-eslint/recommended"
34 | ],
35 | "plugins": [
36 | "@typescript-eslint"
37 | ],
38 | "rules": {
39 | "default-case": "off",
40 | "no-dupe-class-members": "off",
41 | "no-undef": "off",
42 | "no-array-constructor": "off",
43 | "@typescript-eslint/no-array-constructor": "error",
44 | "no-use-before-define": "off",
45 | "@typescript-eslint/no-use-before-define": [
46 | "error",
47 | {
48 | "functions": false,
49 | "classes": false,
50 | "variables": false,
51 | "typedefs": false
52 | }
53 | ],
54 | "@typescript-eslint/no-non-null-assertion": "off",
55 | "@typescript-eslint/no-explicit-any": "off",
56 | "@typescript-eslint/no-object-literal-type-assertion": "off",
57 | "@typescript-eslint/explicit-member-accessibility": "off",
58 | "no-unused-vars": "off",
59 | "@typescript-eslint/no-unused-vars": [
60 | "error",
61 | {
62 | "args": "none",
63 | "ignoreRestSiblings": true
64 | }
65 | ],
66 | "no-useless-constructor": "off",
67 | "@typescript-eslint/no-useless-constructor": "error",
68 | "@typescript-eslint/explicit-function-return-type": "off",
69 | "@typescript-eslint/prefer-interface": "off",
70 | "@typescript-eslint/no-namespace": "off",
71 | "@typescript-eslint/explicit-module-boundary-types": "off"
72 | }
73 | }
74 | ]
75 | }
--------------------------------------------------------------------------------
/template/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/ignore-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 |
6 | # testing
7 | /coverage
8 |
9 | # production
10 | /build
11 | /dist
12 |
13 | # misc
14 | .DS_Store
15 | .env.local
16 | .env.development.local
17 | .env.test.local
18 | .env.production.local
19 |
20 | npm-debug.log*
21 | yarn-debug.log*
22 | yarn-error.log*
--------------------------------------------------------------------------------
/template/gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/ignore-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 |
6 | # testing
7 | /coverage
8 |
9 | # production
10 | /build
11 | /dist
12 |
13 | # misc
14 | .DS_Store
15 | .env.local
16 | .env.development.local
17 | .env.test.local
18 | .env.production.local
19 |
20 | npm-debug.log*
21 | yarn-debug.log*
22 | yarn-error.log*
--------------------------------------------------------------------------------
/template/setupTests.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is used to set up the testing framework
3 | * before each test is executed.
4 | *
5 | * For more information, please consult:
6 | * https://facebook.github.io/jest/docs/en/configuration.html#setuptestframeworkscriptfile-string
7 | */
8 |
--------------------------------------------------------------------------------
/template/src/App.ts:
--------------------------------------------------------------------------------
1 | export default () => {
2 | // eslint-disable-next-line
3 | console.log('App is running');
4 | };
5 |
--------------------------------------------------------------------------------
/template/src/__tests__/App.ts:
--------------------------------------------------------------------------------
1 | import App from "../App";
2 |
3 | describe("test", () => {
4 | it("runs", () => {
5 | expect(1).toEqual(1);
6 | });
7 | it("default of App export is a function", () => {
8 | expect(typeof App === "function").toBe(true);
9 | });
10 | });
11 |
--------------------------------------------------------------------------------
/template/src/index.ts:
--------------------------------------------------------------------------------
1 | import App from "./App";
2 |
3 | App();
4 |
--------------------------------------------------------------------------------
/template/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "outDir": "build",
4 | "module": "commonjs",
5 | "target": "es6",
6 | "allowJs": true,
7 | "moduleResolution": "node",
8 | "rootDir": "src",
9 | "strict": true,
10 | "noImplicitReturns": true,
11 | "noUnusedLocals": true,
12 | "resolveJsonModule": true,
13 | "sourceMap": true
14 | },
15 | "exclude": ["node_modules", "build", "coverage", "dist", "setupTests.ts"]
16 | }
17 |
--------------------------------------------------------------------------------
/tests/e2e.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
3 |
4 | # test if in docker or CI environment
5 | # this script should only be running in docker or a CI environment!
6 | if [ -f /.dockerenv ] || [ -n "${CI}" ] ; then
7 | echo "Detected script running in Docker or CI environment."
8 | else
9 | echo "ERR! This script is intended to be used inside Docker or a CI environment."
10 | echo "ERR! Run 'yarn e2e:local' instead."
11 | exit 1
12 | fi
13 |
14 | # start in the directory where the script runs
15 | cd $SCRIPT_DIR
16 |
17 | TEMP_APP_PATH=`mktemp -d`
18 | VERDACCIO_REGISTRY_URL=http://localhost:4873
19 |
20 | function exists {
21 | for f in $*; do
22 | test -e "$f"
23 | done
24 | }
25 |
26 | # exit if any command fails
27 | set -e
28 | # echo every command being executed
29 | set -x
30 |
31 | # go back to root directory
32 | cd ..
33 |
34 | # update npm
35 | npm i -g npm@latest
36 |
37 | # install deps
38 | yarn
39 |
40 | # compile
41 | yarn compile
42 |
43 | # start verdaccio
44 | VERDACCIO_REGISTRY_LOGS=`mktemp`
45 | nohup npx verdaccio@4.3.5 -c tests/verdaccio.yml &>$VERDACCIO_REGISTRY_LOGS &
46 | # wait for verdaccio to boot
47 | grep -q 'http address' <(tail -f $VERDACCIO_REGISTRY_LOGS)
48 |
49 | # set registry to verdaccio registry
50 | npm set registry "$VERDACCIO_REGISTRY_URL"
51 | yarn config set registry "$VERDACCIO_REGISTRY_URL"
52 |
53 | # login to custom registy
54 | (cd && npx npm-auth-to-token@1.0.0 -u user -p password -e user@example.com -r "$VERDACCIO_REGISTRY_URL")
55 |
56 | #==============================#
57 | # Test development environment #
58 | #==============================#
59 | # lint project
60 | yarn lint
61 | # test templates
62 | yarn build
63 | # check for local build files
64 | exists template/dist/*.js
65 | CI=true yarn test
66 |
67 | # force git user (github actions doesn't seem to support this well)
68 | git config --global user.email "actions@github.com"
69 | git config --global user.name "GitHub Actions"
70 |
71 | echo "node_modules/" > .gitignore
72 | git init && git add . && git commit -m "feat(package): fake commit"
73 |
74 | # bump version so that we can 'deploy' to verdaccio
75 | npm version patch --force
76 | # publish to verdaccio
77 | npm publish
78 |
79 | #================================#
80 | # Test end user install from npm #
81 | #================================#
82 | # simulate end user installs
83 | cd $TEMP_APP_PATH
84 | npx typescript-node-scripts create test-app
85 |
86 | cd test-app
87 | exists node_modules/typescript-node-scripts
88 |
89 | #========================#
90 | # Test generated project #
91 | #========================#
92 | # build
93 | yarn build
94 | # check for build files
95 | exists dist/*.js
96 | CI=true yarn test
97 |
98 | #=======================#
99 | # Prepare sink tsconfig #
100 | #=======================#
101 | rm -rf ./tsconfig.json
102 | cp "$SCRIPT_DIR/sink/tsconfig.json" ./tsconfig.json
103 |
104 | #=================================================#
105 | # Run sink/ts-js-integration in generated project #
106 | #=================================================#
107 | # remove src folder
108 | rm -rf src/*
109 | # copy the ts-js-integration files to src
110 | cp -a "$SCRIPT_DIR/sink/ts-js-integration/." ./src
111 | # run the build and execute the bundle
112 | yarn build
113 | node dist/bundle.prod.js
114 | # run the test files
115 | CI=true yarn test
116 |
117 |
118 | #==============================================#
119 | # Run sink/typescript-3.7 in generated project #
120 | #==============================================#
121 | # remove src folder
122 | rm -rf src/*
123 | # copy the ts-js-integration files to src
124 | cp -a "$SCRIPT_DIR/sink/typescript-3.7/." ./src
125 | # run the build and execute the bundle
126 | yarn build
127 | # run the test files
128 | CI=true yarn test
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/__tests__/cjs.js:
--------------------------------------------------------------------------------
1 | import cjs from '../cjs'
2 | import cjsNonDefault, { TEST } from '../cjs'
3 |
4 | describe('cjs', () => {
5 | it('can import star exports', () => {
6 | expect(typeof cjs.TEST === 'number').toBe(true)
7 | expect(typeof cjs.default === 'function').toBe(true)
8 | })
9 | it('can import named exports', () => {
10 | expect(typeof TEST === 'number').toBe(true)
11 | expect(typeof cjsNonDefault.default === 'function').toBe(true)
12 | })
13 | })
14 |
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/__tests__/esm.js:
--------------------------------------------------------------------------------
1 | import * as esm from '../esm'
2 | import esmDefault, { TEST } from '../esm'
3 |
4 | describe('esm', () => {
5 | it('can import star exports', () => {
6 | expect(typeof esm.TEST === 'number').toBe(true)
7 | expect(typeof esm.default === 'function').toBe(true)
8 | })
9 | it('can import named exports', () => {
10 | expect(typeof TEST === 'number').toBe(true)
11 | expect(typeof esmDefault === 'function').toBe(true)
12 | })
13 | })
14 |
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/__tests__/ts-import-js.ts:
--------------------------------------------------------------------------------
1 | import * as cjs from "../cjs";
2 | import cjsDefault, {
3 | readFileSync as CJS_READ_FILE_SYNC,
4 | TEST as CJS_TEST,
5 | } from "../cjs";
6 | import * as esm from "../esm";
7 | import esmDefault, {
8 | readFileSync as ESM_READ_FILE_SYNC,
9 | TEST as ESM_TEST,
10 | } from "../cjs";
11 |
12 | describe("importing js from ts", () => {
13 | describe("cjs", () => {
14 | it("can import named exports", () => {
15 | expect(typeof cjsDefault === "function").toBe(true);
16 | expect(typeof CJS_READ_FILE_SYNC === "function").toBe(true);
17 | expect(typeof CJS_TEST === "number").toBe(true);
18 | });
19 | it("can import star imports", () => {
20 | expect(typeof cjs.default === "function").toBe(true);
21 | expect(typeof cjs.readFileSync === "function").toBe(true);
22 | expect(typeof cjs.TEST === "number").toBe(true);
23 | });
24 | });
25 | describe("esm", () => {
26 | it("can import named exports", () => {
27 | expect(typeof esmDefault === "function").toBe(true);
28 | expect(typeof ESM_READ_FILE_SYNC === "function").toBe(true);
29 | expect(typeof ESM_TEST === "number").toBe(true);
30 | });
31 | it("can import star imports", () => {
32 | expect(typeof esm.default === "function").toBe(true);
33 | expect(typeof esm.readFileSync === "function").toBe(true);
34 | expect(typeof esm.TEST === "number").toBe(true);
35 | });
36 | });
37 | });
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/__tests__/ts.ts:
--------------------------------------------------------------------------------
1 | import * as tsRelative from "../ts";
2 | import * as tsAbsolute from "~/ts";
3 |
4 | describe("ts: absolute imports", () => {
5 | it("exports variables", () => {
6 | expect(typeof tsRelative.TEST === "number").toBe(true);
7 | });
8 | it("exports default", () => {
9 | expect(typeof tsRelative.default === "function").toBe(true);
10 | });
11 | });
12 |
13 | describe("ts: relative imports", () => {
14 | it("exports variables", () => {
15 | expect(typeof tsAbsolute.TEST === "number").toBe(true);
16 | });
17 | it("exports default", () => {
18 | expect(typeof tsAbsolute.default === "function").toBe(true);
19 | });
20 | });
21 |
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/cjs.js:
--------------------------------------------------------------------------------
1 | // eslint-disable-next-line @typescript-eslint/no-var-requires
2 | const fs = require("fs");
3 |
4 | module.exports = {
5 | TEST: 2,
6 | default: () => 1,
7 | readFileSync: fs.readFileSync
8 | };
9 |
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/esm.js:
--------------------------------------------------------------------------------
1 | import fs from "fs";
2 |
3 | export const readFileSync = fs.readFileSync;
4 | export const TEST = 2;
5 | export default () => {
6 | // eslint-disable-next-line
7 | console.log('App is running');
8 | };
9 |
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/index.ts:
--------------------------------------------------------------------------------
1 | import * as assert from "assert";
2 | import * as cjs from "./cjs";
3 | import esmDefault, {
4 | readFileSync as ESM_READ_FILE_SYNC,
5 | TEST as ESM_TEST
6 | } from "./cjs";
7 | import cjsDefault, {
8 | readFileSync as CJS_READ_FILE_SYNC,
9 | TEST as CJS_TEST
10 | } from "./cjs";
11 | import * as esm from "./esm";
12 |
13 | assert(typeof cjsDefault === "function");
14 | assert(typeof CJS_READ_FILE_SYNC === "function");
15 | assert(typeof CJS_TEST === "number");
16 | assert(typeof cjs.default === "function");
17 | assert(typeof cjs.readFileSync === "function");
18 | assert(typeof cjs.TEST === "number");
19 | assert(typeof esmDefault === "function");
20 | assert(typeof ESM_READ_FILE_SYNC === "function");
21 | assert(typeof ESM_TEST === "number");
22 | assert(typeof esm.default === "function");
23 | assert(typeof esm.readFileSync === "function");
24 | assert(typeof esm.TEST === "number");
25 |
--------------------------------------------------------------------------------
/tests/sink/ts-js-integration/ts.ts:
--------------------------------------------------------------------------------
1 | export const TEST = 2;
2 | export default () => {
3 | // eslint-disable-next-line
4 | console.log('App is running');
5 | };
6 |
--------------------------------------------------------------------------------
/tests/sink/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "baseUrl": ".",
4 | "outDir": "build",
5 | "module": "commonjs",
6 | "target": "es6",
7 | "allowJs": true,
8 | "moduleResolution": "node",
9 | "rootDir": "src",
10 | "strict": true,
11 | "noImplicitReturns": true,
12 | "noUnusedLocals": true,
13 | "resolveJsonModule": true,
14 | "sourceMap": true,
15 | "paths": {
16 | "~/*": ["src/*"]
17 | }
18 | },
19 | "exclude": ["node_modules", "build", "coverage", "dist", "setupTests.ts"]
20 | }
21 |
--------------------------------------------------------------------------------
/tests/sink/typescript-3.7/__tests__/index.test.ts:
--------------------------------------------------------------------------------
1 | import { f, OptChainType } from '../index'
2 |
3 | describe('optional chaining and nullish coalesing', () => {
4 | it('returns Infinity if any of the paths of OptChainType is undefined', () => {
5 | const optChainObject: OptChainType = {
6 | a: {}
7 | }
8 | expect(f(optChainObject)).toEqual(Infinity)
9 | })
10 | it('returns a.b.c if all of the paths of OptChainType is defined', () => {
11 | const optChainObject: OptChainType = {
12 | a: {
13 | b: {
14 | c: 0
15 | }
16 | }
17 | }
18 | expect(f(optChainObject)).toEqual(optChainObject.a!.b!.c)
19 | })
20 | })
--------------------------------------------------------------------------------
/tests/sink/typescript-3.7/index.ts:
--------------------------------------------------------------------------------
1 | export type OptChainType = {
2 | a?: {
3 | b?: {
4 | c: number;
5 | };
6 | };
7 | }
8 |
9 | export function f(arg: OptChainType) {
10 | return arg.a?.b?.c ?? Infinity
11 | }
12 |
--------------------------------------------------------------------------------
/tests/verdaccio.yml:
--------------------------------------------------------------------------------
1 | #
2 | # This is based on verdaccio's default config file. It allows all users
3 | # to do anything, so don't use it on production systems.
4 | #
5 | # Look here for more config file examples:
6 | # https://github.com/verdaccio/verdaccio/tree/master/conf
7 | #
8 |
9 | # path to a directory with all packages
10 | storage: ./storage
11 |
12 | auth:
13 | htpasswd:
14 | file: ./htpasswd
15 | # Maximum amount of users allowed to register, defaults to "+inf".
16 | # You can set this to -1 to disable registration.
17 | #max_users: 1000
18 |
19 | # a list of other known repositories we can talk to
20 | uplinks:
21 | npmjs:
22 | url: https://registry.npmjs.org/
23 | max_fails: 100
24 | timeout: 60
25 | agent_options:
26 | keepAlive: true
27 |
28 | packages:
29 | '@*/*':
30 | # scoped packages
31 | access: $all
32 | publish: $all
33 | proxy: npmjs
34 |
35 | '**':
36 | # allow all users (including non-authenticated users) to read and
37 | # publish all packages
38 | #
39 | # you can specify usernames/groupnames (depending on your auth plugin)
40 | # and three keywords: "$all", "$anonymous", "$authenticated"
41 | access: $all
42 |
43 | # allow all known users to publish packages
44 | # (anyone can register by default, remember?)
45 | publish: $all
46 |
47 | # if package is not available locally, proxy requests to 'npmjs' registry
48 | proxy: npmjs
49 |
50 | # log settings
51 | logs:
52 | - {type: stdout, format: pretty, level: http}
53 | #- {type: file, path: verdaccio.log, level: info}
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | /* Basic Options */
4 | "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
5 | "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
6 | // "lib": [], /* Specify library files to be included in the compilation. */
7 | "allowJs": false, /* Allow javascript files to be compiled. */
8 | // "checkJs": true, /* Report errors in .js files. */
9 | // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
10 | // "declaration": true, /* Generates corresponding '.d.ts' file. */
11 | // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
12 | "sourceMap": true, /* Generates corresponding '.map' file. */
13 | // "outFile": "./", /* Concatenate and emit output to single file. */
14 | "outDir": "./build", /* Redirect output structure to the directory. */
15 | // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
16 | // "composite": true, /* Enable project compilation */
17 | // "removeComments": true, /* Do not emit comments to output. */
18 | // "noEmit": true, /* Do not emit outputs. */
19 | "importHelpers": true, /* Import emit helpers from 'tslib'. */
20 | // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
21 | // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
22 |
23 | /* Strict Type-Checking Options */
24 | "strict": true, /* Enable all strict type-checking options. */
25 | // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
26 | // "strictNullChecks": true, /* Enable strict null checks. */
27 | // "strictFunctionTypes": true, /* Enable strict checking of function types. */
28 | // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
29 | // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
30 | // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
31 | // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
32 |
33 | /* Additional Checks */
34 | "noUnusedLocals": true, /* Report errors on unused locals. */
35 | // "noUnusedParameters": true, /* Report errors on unused parameters. */
36 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
37 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
38 |
39 | /* Module Resolution Options */
40 | "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
41 | // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
42 | // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
43 | // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
44 | // "typeRoots": [], /* List of folders to include type definitions from. */
45 | // "types": [], /* Type declaration files to be included in compilation. */
46 | // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
47 | "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
48 | // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
49 |
50 | /* Source Map Options */
51 | // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
52 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
53 | // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
54 | // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
55 |
56 | /* Experimental Options */
57 | // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
58 | // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
59 | "skipLibCheck": true
60 | },
61 | "include": ["src", "vendor"],
62 | "exclude": ["node_modules"]
63 | }
64 |
--------------------------------------------------------------------------------
/vendor/@babel/code-frame.d.ts:
--------------------------------------------------------------------------------
1 | declare module '@babel/code-frame' {
2 | interface BabelCodeFrameOptions {
3 | /** Syntax highlight the code as JavaScript for terminals. default: false */
4 | highlightCode?: boolean
5 | /** The number of lines to show above the error. default: 2 */
6 | linesBelow?: number
7 | /** The number of lines to show below the error. default: 3 */
8 | linesAbove?: number
9 | /**
10 | * Forcibly syntax highlight the code as JavaScript (for non-terminals);
11 | * overrides highlightCode.
12 | * default: false
13 | */
14 | forceColor?: boolean
15 | }
16 |
17 | interface BabelCodeFrameLineConfiguration {
18 | start?: {
19 | column?: number
20 | line?: number
21 | }
22 | end?: {
23 | column?: number
24 | line?: number
25 | }
26 | }
27 |
28 | /**
29 | * Generate errors that contain a code frame that point to source locations.
30 | *
31 | * @param rawLines Raw lines to frame
32 | * @param lineNumber Line number (1 indexed)
33 | * @param colNumber Column number
34 | * @param options Additional options
35 | *
36 | * @returns Framed code
37 | */
38 | export function codeFrameColumns(
39 | rawLines: string,
40 | loc: BabelCodeFrameLineConfiguration,
41 | options?: BabelCodeFrameOptions
42 | ): string
43 | }
44 |
--------------------------------------------------------------------------------
/vendor/pstree.remy.d.ts:
--------------------------------------------------------------------------------
1 | declare module 'pstree.remy' {
2 | export const hasPS: boolean
3 | export default function main(
4 | pid: string,
5 | callback: (error: Error, children: string[]) => void
6 | ): void
7 | }
8 |
--------------------------------------------------------------------------------
/website/README.md:
--------------------------------------------------------------------------------
1 | This website was created with [Docusaurus](https://docusaurus.io/).
2 |
3 | # What's In This Document
4 |
5 | * [Get Started in 5 Minutes](#get-started-in-5-minutes)
6 | * [Directory Structure](#directory-structure)
7 | * [Editing Content](#editing-content)
8 | * [Adding Content](#adding-content)
9 | * [Full Documentation](#full-documentation)
10 |
11 | # Get Started in 5 Minutes
12 |
13 | 1. Make sure all the dependencies for the website are installed:
14 |
15 | ```sh
16 | # Install dependencies
17 | $ yarn
18 | ```
19 | 2. Run your dev server:
20 |
21 | ```sh
22 | # Start the site
23 | $ yarn start
24 | ```
25 |
26 | ## Directory Structure
27 |
28 | Your project file structure should look something like this
29 |
30 | ```
31 | my-docusaurus/
32 | docs/
33 | doc-1.md
34 | doc-2.md
35 | doc-3.md
36 | website/
37 | blog/
38 | 2016-3-11-oldest-post.md
39 | 2017-10-24-newest-post.md
40 | core/
41 | node_modules/
42 | pages/
43 | static/
44 | css/
45 | img/
46 | package.json
47 | sidebar.json
48 | siteConfig.js
49 | ```
50 |
51 | # Editing Content
52 |
53 | ## Editing an existing docs page
54 |
55 | Edit docs by navigating to `docs/` and editing the corresponding document:
56 |
57 | `docs/doc-to-be-edited.md`
58 |
59 | ```markdown
60 | ---
61 | id: page-needs-edit
62 | title: This Doc Needs To Be Edited
63 | ---
64 |
65 | Edit me...
66 | ```
67 |
68 | For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
69 |
70 | ## Editing an existing blog post
71 |
72 | Edit blog posts by navigating to `website/blog` and editing the corresponding post:
73 |
74 | `website/blog/post-to-be-edited.md`
75 | ```markdown
76 | ---
77 | id: post-needs-edit
78 | title: This Blog Post Needs To Be Edited
79 | ---
80 |
81 | Edit me...
82 | ```
83 |
84 | For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
85 |
86 | # Adding Content
87 |
88 | ## Adding a new docs page to an existing sidebar
89 |
90 | 1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
91 |
92 | ```md
93 | ---
94 | id: newly-created-doc
95 | title: This Doc Needs To Be Edited
96 | ---
97 |
98 | My new content here..
99 | ```
100 |
101 | 1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:
102 |
103 | ```javascript
104 | // Add newly-created-doc to the Getting Started category of docs
105 | {
106 | "docs": {
107 | "Getting Started": [
108 | "quick-start",
109 | "newly-created-doc" // new doc here
110 | ],
111 | ...
112 | },
113 | ...
114 | }
115 | ```
116 |
117 | For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
118 |
119 | ## Adding a new blog post
120 |
121 | 1. Make sure there is a header link to your blog in `website/siteConfig.js`:
122 |
123 | `website/siteConfig.js`
124 | ```javascript
125 | headerLinks: [
126 | ...
127 | { blog: true, label: 'Blog' },
128 | ...
129 | ]
130 | ```
131 |
132 | 2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
133 |
134 | `website/blog/2018-05-21-New-Blog-Post.md`
135 |
136 | ```markdown
137 | ---
138 | author: Frank Li
139 | authorURL: https://twitter.com/foobarbaz
140 | authorFBID: 503283835
141 | title: New Blog Post
142 | ---
143 |
144 | Lorem Ipsum...
145 | ```
146 |
147 | For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
148 |
149 | ## Adding items to your site's top navigation bar
150 |
151 | 1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
152 |
153 | `website/siteConfig.js`
154 | ```javascript
155 | {
156 | headerLinks: [
157 | ...
158 | /* you can add docs */
159 | { doc: 'my-examples', label: 'Examples' },
160 | /* you can add custom pages */
161 | { page: 'help', label: 'Help' },
162 | /* you can add external links */
163 | { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
164 | ...
165 | ],
166 | ...
167 | }
168 | ```
169 |
170 | For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
171 |
172 | ## Adding custom pages
173 |
174 | 1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
175 | 1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
176 |
177 | `website/siteConfig.js`
178 | ```javascript
179 | {
180 | headerLinks: [
181 | ...
182 | { page: 'my-new-custom-page', label: 'My New Custom Page' },
183 | ...
184 | ],
185 | ...
186 | }
187 | ```
188 |
189 | For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
190 |
191 | # Full Documentation
192 |
193 | Full documentation can be found on the [website](https://docusaurus.io/).
194 |
--------------------------------------------------------------------------------
/website/core/Footer.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react')
9 |
10 | class Footer extends React.Component {
11 | docUrl(doc, language) {
12 | const baseUrl = this.props.config.baseUrl
13 | const docsUrl = this.props.config.docsUrl
14 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`
15 | const langPart = `${language ? `${language}/` : ''}`
16 | return `${baseUrl}${docsPart}${langPart}${doc}`
17 | }
18 |
19 | pageUrl(doc, language) {
20 | const baseUrl = this.props.config.baseUrl
21 | return baseUrl + (language ? `${language}/` : '') + doc
22 | }
23 |
24 | render() {
25 | return (
26 |
103 | )
104 | }
105 | }
106 |
107 | module.exports = Footer
108 |
--------------------------------------------------------------------------------
/website/i18n/en.json:
--------------------------------------------------------------------------------
1 | {
2 | "_comment": "This file is auto-generated by write-translations.js",
3 | "localized-strings": {
4 | "next": "Next",
5 | "previous": "Previous",
6 | "tagline": "Create Node.js apps based on TypeScript with zero-configuration",
7 | "docs": {
8 | "adding-prettier": {
9 | "title": "Adding Prettier"
10 | },
11 | "argv-forwarding": {
12 | "title": "Forwarding argv to your App"
13 | },
14 | "commands": {
15 | "title": "Commands Reference"
16 | },
17 | "custom-module-path": {
18 | "title": "Custom Module Paths"
19 | },
20 | "debugging-source": {
21 | "title": "Debugging your Source"
22 | },
23 | "debugging-webpack": {
24 | "title": "Debugging your Webpack Build"
25 | },
26 | "deployment": {
27 | "title": "Deploying your App"
28 | },
29 | "getting-started": {
30 | "title": "Getting Started"
31 | },
32 | "migrating-v2-to-v3": {
33 | "title": "Migrating from v2 to v3"
34 | },
35 | "monorepo": {
36 | "title": "Monorepo Support"
37 | },
38 | "sourcemaps": {
39 | "title": "Source Maps"
40 | },
41 | "tests": {
42 | "title": "Testing your Application"
43 | },
44 | "upgrading": {
45 | "title": "Upgrading + Changelog"
46 | },
47 | "webpack-override": {
48 | "title": "Overriding Webpack Configuration"
49 | }
50 | },
51 | "links": {
52 | "Docs": "Docs",
53 | "GitHub": "GitHub"
54 | },
55 | "categories": {
56 | "Quick Start": "Quick Start",
57 | "Guides": "Guides",
58 | "Debugging": "Debugging",
59 | "Advanced": "Advanced",
60 | "Upgrading and Changelog": "Upgrading and Changelog",
61 | "First Category": "First Category"
62 | }
63 | },
64 | "pages-strings": {
65 | "Help Translate|recruit community translators for your project": "Help Translate",
66 | "Edit this Doc|recruitment message asking to edit the doc source": "Edit",
67 | "Translate this Doc|recruitment message asking to translate the docs": "Translate"
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/website/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "scripts": {
3 | "examples": "docusaurus-examples",
4 | "start": "docusaurus-start",
5 | "build": "docusaurus-build",
6 | "publish-gh-pages": "docusaurus-publish",
7 | "write-translations": "docusaurus-write-translations",
8 | "version": "docusaurus-version",
9 | "rename-version": "docusaurus-rename-version"
10 | },
11 | "devDependencies": {
12 | "docusaurus": "1.14.6"
13 | },
14 | "dependencies": {}
15 | }
16 |
--------------------------------------------------------------------------------
/website/pages/en/help.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react')
9 |
10 | const CompLibrary = require('../../core/CompLibrary.js')
11 |
12 | const Container = CompLibrary.Container
13 | const GridBlock = CompLibrary.GridBlock
14 |
15 | function Help(props) {
16 | const { config: siteConfig, language = '' } = props
17 | const { baseUrl, docsUrl } = siteConfig
18 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`
19 | const langPart = `${language ? `${language}/` : ''}`
20 | const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`
21 |
22 | const supportLinks = [
23 | {
24 | content: `Learn more using the [documentation on this site.](${docUrl(
25 | 'doc1.html'
26 | )})`,
27 | title: 'Browse Docs',
28 | },
29 | {
30 | content: 'Ask questions about the documentation and project',
31 | title: 'Join the community',
32 | },
33 | {
34 | content: "Find out what's new with this project",
35 | title: 'Stay up to date',
36 | },
37 | ]
38 |
39 | return (
40 |
41 |
42 |
43 |
46 |
This project is maintained by a dedicated group of people.
47 |
48 |
50 |
26 |
27 |
{props.children}
28 |
29 |
34 | {siteConfig.title}
35 | {siteConfig.tagline}
36 |
37 | )
38 |
39 | const PromoSection = props => (
40 |
41 |
42 |
{props.children}
43 |
44 |
57 |
58 |
59 |
63 |
64 | Try It Out
65 | Documentation
66 |
67 |
69 | )
70 | }
71 | }
72 |
73 | class Index extends React.Component {
74 | render() {
75 | const { config: siteConfig, language = '' } = this.props
76 | const { baseUrl } = siteConfig
77 |
78 | const Block = props => (
79 |
84 |
90 | )
91 |
92 | const FeatureCallout = () => (
93 |
97 |
Create, build, test, and deploy
98 |
99 | {/* TNS makes it easy to create applications with one command,
100 | and provides helpful tools like a development server that incrementally compiles your source code,
101 | making it blazing fast to develop your application. */}
102 | TNS makes it easy to create, build, and test your Node.js applications
103 | with built-in tooling, like a development server that incrementally
104 | compiles your source code and runs your app.
105 |
106 |
107 | )
108 |
109 | const TryOut = () => (
110 |
111 | {[
112 | {
113 | title: 'Try it Out',
114 | content: `Ready to create an app? Run the following command in your terminal:
115 |
118 | \`\`\``,
119 | },
120 | ]}
121 |
122 | )
123 |
124 | const BuildAndRun = () => (
125 |
126 | {[
127 | {
128 | content:
129 | 'TNS provides a development server which compiles your source code incrementally, and then runs your application in the same terminal.',
130 | image: `${baseUrl}img/dev-server.png`,
131 | imageAlign: 'bottom',
132 | title: 'Compile and Run',
133 | },
134 | ]}
135 |
136 | )
137 |
138 | const HelpfulErrorMessages = () => (
139 |
140 | {[
141 | {
142 | content:
143 | 'TNS outputs a prettified error message along with the source of the error, and silences other errors that cascade from the current error.',
144 | image: `${baseUrl}img/dev-server-error.png`,
145 | imageAlign: 'bottom',
146 | title: 'Distraction-free Error Messages',
147 | },
148 | ]}
149 |
150 | )
151 |
152 | const Test = () => (
153 |
154 | {[
155 | {
156 | content:
157 | 'Jest ships out of the box. Run your tests and update your snapshots, all in interactive mode. ',
158 | image: `${baseUrl}img/test.png`,
159 | imageAlign: 'bottom',
160 | title: 'Test',
161 | },
162 | ]}
163 |
164 | )
165 |
166 | const Build = () => (
167 |
168 | {[
169 | {
170 | content:
171 | 'Build a production ready, minified, and optimized bundle with one command',
172 | image: `${baseUrl}img/build.png`,
173 | imageAlign: 'bottom',
174 | title: 'Build',
175 | },
176 | ]}
177 |
178 | )
179 |
180 | const Features = () => (
181 |
182 | {[
183 | {
184 | content: 'TNS works out of the box, no configuration required',
185 | image: `${baseUrl}img/gear.svg`,
186 | imageAlign: 'top',
187 | title: 'Zero Config',
188 | },
189 | {
190 | content:
191 | 'TNS supports TypeScript in addition to JavaScript sources',
192 | image: `${baseUrl}img/typescript.png`,
193 | imageAlign: 'top',
194 | title: 'TypeScript + Babel',
195 | },
196 | {
197 | title: 'Webpack',
198 | content:
199 | 'TNS transforms your source files into a single bundle through Webpack with source maps, which makes it easy to deploy and debug.',
200 | image: `${baseUrl}img/webpack.svg`,
201 | imageAlign: 'top',
202 | },
203 | ]}
204 |
205 | )
206 |
207 | // const Showcase = () => {
208 | // if ((siteConfig.users || []).length === 0) {
209 | // return null;
210 | // }
211 |
212 | // const showcase = siteConfig.users
213 | // .filter(user => user.pinned)
214 | // .map(user => (
215 | //
216 | //
218 | // ));
219 |
220 | // const pageUrl = page => baseUrl + (language ? `${language}/` : '') + page;
221 |
222 | // return (
223 | //
224 | //
Who is Using This?
225 | //
This project is used by all these people
226 | //
{showcase}
227 | //
232 | //
238 |
239 |
240 |
248 |
24 |
26 | ))
27 |
28 | return (
29 |
30 |
31 |
32 |
33 |
Who is Using This?
34 |
This project is used by many folks
35 |
36 |
{showcase}
37 |
Are you using this project?
38 |
39 | Add your company
40 |
41 |
43 |
11 |