Skip to content

Commit

Permalink
Add template
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienvillar committed Aug 30, 2022
0 parents commit 1b46749
Show file tree
Hide file tree
Showing 11 changed files with 1,141 additions and 0 deletions.
800 changes: 800 additions & 0 deletions .eslintrc.cjs

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.idea/
.DS_Store
node_modules/
npm-debug.log.*
yarn-error.log
dist/
.env
.vscode/*

## MacOS
.DS_Store

## User settings
xcuserdata/

## Config
*.xcconfig
18 changes: 18 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Same as .gitignore but does not ignore the dist folder

.idea/
.DS_Store
node_modules/
npm-debug.log.*
yarn-error.log
.env
.vscode/*

## MacOS
.DS_Store

## User settings
xcuserdata/

## Config
*.xcconfig
25 changes: 25 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"tabWidth": 2,
"printWidth": 160,
"semi": true,
"singleQuote": true,
"jsxSingleQuote": false,
"trailingComma": "all",
"bracketSpacing": false,
"jsxBracketSameLine": false,
"arrowParens": "always",
"overrides": [
{
"files": ".prettierrc",
"options": {
"parser": "json"
}
},
{
"files": "*.ejs",
"options": {
"parser": "html"
}
}
]
}
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Height CLI
7 changes: 7 additions & 0 deletions configs/tsconfig.cjs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "../tsconfig",
"compilerOptions": {
"module": "commonjs",
"outDir": "../dist/cjs"
}
}
7 changes: 7 additions & 0 deletions configs/tsconfig.esm.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "../tsconfig",
"compilerOptions": {
"module": "ESNext",
"outDir": "../dist/esm"
}
}
12 changes: 12 additions & 0 deletions configs/tsconfig.types.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"extends": "../tsconfig",
"compilerOptions": {
"declaration": true,
"emitDeclarationOnly": true,
"outDir": "../dist/types",
},
"tsc-alias": {
"verbose": false,
"resolveFullPaths": true,
}
}
35 changes: 35 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"name": "@heightapp/cli",
"version": "1.0.0",
"description": "",
"type": "module",
"engines": {
"node": ">=16.0.0"
},
"bin": {
"height": "dist/esm/cli.js"
},
"scripts": {
"build": "NODE_ENV=production ./scripts/build.js --esm",
"dev": "NODE_ENV=development ./scripts/build.js --esm && node dist/esm/cli.js",
"debug": "HEIGHT_DEBUG=true npm run dev",
"lint": "eslint ./src",
"prepare": "npm run build"
},
"repository": "git+https://github.com/heightapp/cli.git",
"author": "Height",
"license": "MIT",
"bugs": {
"url": "https://github.com/heightapp/cli/issues"
},
"homepage": "https://github.com/heightapp/cli#readme",
"devDependencies": {
"@types/node": "^18.6.2",
"@typescript-eslint/eslint-plugin": "^5.31.0",
"@typescript-eslint/parser": "^5.31.0",
"esbuild": "^0.14.53",
"eslint": "^8.20.0",
"eslint-plugin-import": "^2.26.0",
"typescript": "^4.7.4"
},
}
111 changes: 111 additions & 0 deletions scripts/build.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
#! /usr/bin/env node

import {exec as execSync} from 'child_process';
import esbuild from 'esbuild';
import fs from 'fs';
import yargs from 'yargs/yargs';
import {hideBin} from 'yargs/helpers';
import util from 'util';
import path from 'path';

const exec = util.promisify(execSync);

const args = yargs(hideBin(process.argv))
.option('esm', {
describe: 'Generate esm bundle',
type: 'boolean',
})
.option('cjs', {
describe: 'Generate cjs bundel',
type: 'boolean',
})
.option('types', {
describe: 'Generate types',
type: 'boolean',
}).argv;

const entryPoints = ['src/cli.ts', 'src/watch.ts'];

const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
const external = Object.keys({
...(packageJson.dependencies || {}),
...(packageJson.devDependencies || {}),
...(packageJson.peerDependencies || {}),
...(packageJson.optionalDependencies || {}),
});

const cleanup = () => {
fs.rmSync('./dist', {recursive: true, force: true});
};

const outDirFromConfig = (configPath) => {
const config = JSON.parse(fs.readFileSync(configPath, {encoding: 'utf-8'}));
const outDir = config.compilerOptions.outDir;
return path.resolve('./config', outDir);
};

// Define node env statically since we want this to be part of the build
// and not depend on the user's environment.
const define = {
'process.env.NODE_ENV': `"${process.env.NODE_ENV ?? 'development'}"`,
'process.env.HEIGHT_DEBUG': `${process.env.HEIGHT_DEBUG ?? 'false'}`,
};

const build = async () => {
// Remove the directory before building or moving files fails on Windows (does not override)
cleanup();

try {
const config = {
entryPoints,
bundle: true,
external,
platform: 'node',
treeShaking: true,
define,
};

const promises = [];

// Build ESM
if (args.esm) {
const tsconfig = 'configs/tsconfig.esm.json';
const outdir = outDirFromConfig(tsconfig);
promises.push(
esbuild.build({
...config,
outdir,
format: 'esm',
tsconfig,
}),
);
}

// Build CJS
if (args.cjs) {
const tsconfig = 'configs/tsconfig.cjs.json';
const outdir = outDirFromConfig(tsconfig);
promises.push(
esbuild.build({
...config,
outdir,
format: 'cjs',
tsconfig,
}),
);
}

// Build types
if (args.types) {
const tsconfig = './configs/tsconfig.types.json';
promises.push(exec(`tsc --project ${tsconfig} && tsc-alias --project ${tsconfig}`));
}

await Promise.all(promises);
} catch (e) {
console.error(e.message);
process.exit(1);
}
};

build();
108 changes: 108 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"include": ["./src", "./.eslintrc.cjs"],
"tsc-alias": {
"verbose": false,
"resolveFullPaths": true
},
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
"incremental": true /* Save .tsbuildinfo files to allow for incremental compilation of projects. */,
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "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": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* 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. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "esnext" /* 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": "./src/" /* 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. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'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. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* 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, /* Default catch clause variables as 'unknown' instead of 'any'. */
"alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
// "noUnusedLocals": true, /* Enable error reporting when 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, /* Add 'undefined' to a type when accessed using an index. */
// "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. */
}
}

0 comments on commit 1b46749

Please sign in to comment.