Skip to content

Commit

Permalink
feat: 🚀 renovate commands, directories, tsconfig
Browse files Browse the repository at this point in the history
Renovate commands, add new artifacts dir, fix tsconfig
  • Loading branch information
ben-laird committed Sep 29, 2022
1 parent 166cd5e commit e7e6ada
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 75 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Project-specific exclusions
build
docs
artifacts

# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,node,macos
# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,node,macos
Expand Down
77 changes: 42 additions & 35 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "example",
"version": "1.0.1",
"version": "1.0.0",
"private": true,
"description": "A blank canvas of a repository",
"author": "John Appleseed <johnnyappleseed@example.com>",
"main": "build/main/index.js",
"typings": "build/main/index.d.ts",
"module": "build/module/index.js",
"main": "artifacts/build/main/index.js",
"typings": "artifacts/build/main/index.d.ts",
"module": "artifacts/build/module/index.js",
"repository": "https://github.com/",
"homepage": "https://github.com/",
"bugs": {
Expand All @@ -17,45 +17,50 @@
"keywords": [],
"scripts": {
"sections": "run-s ___Section:*",
"___Section:build": "echo \"build: build the project\"",
"___Section:build": "echo 'build: build the project'",
"build": "run-p build:*",
"build:main": "tsc -p tsconfig.json",
"build:module": "tsc -p tsconfig.module.json",
"___Section:watch": "echo \"watch: run commands in watch mode\"",
"___Section:watch": "echo 'watch: run commands in watch mode'",
"watch:build": "tsc -p tsconfig.json -w",
"watch:test": "nyc --silent ava --watch",
"___Section:fix": "echo \"fix: run linters and formatters to prettify codebase\"",
"___Section:check": "echo 'check: quickly check codebase runs correctly'",
"check": "run-s check:*",
"check:build": "npm run build",
"check:ts": "ts-node src/index.ts",
"check:js": "node artifacts/build/main/index.js",
"___Section:fix": "echo 'fix: run linters and formatters to prettify codebase'",
"fix": "run-s fix:*",
"fix:prettier": "prettier \"src/**/*.ts\" --write",
"fix:prettier": "prettier 'src/**/*.ts' --write",
"fix:lint": "eslint src --color --ext .ts --fix",
"fix:markdown": "markdownlint '**/*.md' --fix --ignore node_modules",
"___Section:test": "echo \"test: run tests\"",
"___Section:test": "echo 'test: run tests'",
"test": "run-s build test:*",
"test:lint": "eslint src --color --ext .ts",
"test:prettier": "prettier \"src/**/*.ts\" --list-different",
"test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
"test:markdown": "markdownlint '**/*.md' --ignore node_modules && cspell \"./**/*.md\"",
"test:unit": "nyc --silent ava",
"___Section:cov": "echo \"cov: execute coverage reports\"",
"cov": "run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html",
"cov:html": "nyc report --reporter=html",
"cov:lcov": "nyc report --reporter=lcov",
"test:prettier": "prettier 'src/**/*.ts' --list-different",
"test:spelling": "cspell '{README.md,.github/*.md,src/**/*.ts}'",
"test:markdown": "markdownlint '**/*.md' --ignore node_modules && cspell './**/*.md'",
"test:unit": "nyc --temp-dir artifacts/.nyc_output ava",
"test-silent-cov": "nyc --silent --temp-dir artifacts/.nyc_output ava",
"test-clean": "run-s test clean",
"___Section:cov": "echo 'cov: execute coverage reports'",
"cov": "run-s build test:unit cov:html cov:lcov && open-cli artifacts/coverage/index.html",
"cov:html": "nyc report --reporter=html --report-dir=artifacts/coverage --temp-dir artifacts/.nyc_output",
"cov:lcov": "nyc report --reporter=lcov --report-dir=artifacts/coverage --temp-dir artifacts/.nyc_output",
"cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
"___Section:docs": "echo \"docs: create documentation\"",
"doc": "run-s doc:html && open-cli docs/index.html",
"___Section:docs": "echo 'docs: create documentation'",
"doc": "run-s doc:html && open-cli artifacts/docs/index.html",
"doc:html": "typedoc src/",
"doc:json": "typedoc src/ --json docs/typedoc.json",
"___Section:clean": "echo \"clean unimportant directories\"",
"clean": "run-p clean:*",
"clean:build": "rm -r build",
"clean:nyc": "rm -r .nyc_output",
"clean:docs": "rm -r docs",
"___Section:cicd": "echo \"run CI/CD commands\"",
"___Section:clean": "echo 'clean unimportant directories'",
"clean": "rm -r artifacts",
"___Section:cicd": "echo 'run CI/CD commands'",
"lint-staged": "lint-staged",
"release": "shipjs prepare",
"___Section:underhood": "echo \"run commands under the hood\"",
"___Section:underhood": "echo 'run commands under the hood'",
"prepare": "husky install"
},
"dependencies": {},
"devDependencies": {
"@ava/typescript": "^3.0.1",
"@commitlint/cli": "^17.0.3",
Expand Down Expand Up @@ -86,8 +91,8 @@
"typescript": "^4.7.4"
},
"files": [
"build/main",
"build/module",
"artifacts/build/main",
"artifacts/build/module",
"!**/*.test.*",
"!**/*.json",
"CHANGELOG.md",
Expand All @@ -99,12 +104,12 @@
"timeout": "60s",
"typescript": {
"rewritePaths": {
"src/": "build/main/"
"src/": "artifacts/build/main/"
},
"compile": "tsc"
},
"files": [
"!build/module/**"
"!artifacts/build/module/**"
]
},
"nyc": {
Expand All @@ -130,8 +135,8 @@
"sourceType": "module"
},
"ignorePatterns": [
"build",
"docs"
"artifacts/build",
"artifacts/docs"
],
"plugins": [
"@typescript-eslint"
Expand All @@ -157,14 +162,16 @@
"editorconfig",
"esnext",
"globby",
"idek",
"lcov",
"mkdir",
"ochem",
"prettierignore",
"sandboxed",
"snyk",
"transpiled",
"typedoc",
"untracked",
"lcov",
"snyk"
"untracked"
],
"ignorePaths": [
"package.json",
Expand Down
52 changes: 15 additions & 37 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,53 +1,31 @@
{
"compilerOptions": {
"incremental": true,
"target": "es2017",
"outDir": "build/main",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "node",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"outDir": "artifacts/build/main",
"rootDir": "src",
"resolveJsonModule": true,
"declaration": true,
"declarationMap": true,
"inlineSourceMap": true,
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
"resolveJsonModule": true /* Include modules imported with .json extension. */,

"strict": true /* Enable all strict type-checking options. */,

/* Strict Type-Checking Options */
// "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
// "strictNullChecks": true /* Enable strict null checks. */,
// "strictFunctionTypes": true /* Enable strict checking of function types. */,
// "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
// "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
// "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,

/* Additional Checks */
"noUnusedLocals": true /* Report errors on unused locals. */,
"noUnusedParameters": true /* Report errors on unused parameters. */,
"noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
"noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,

/* Debugging Options */
"traceResolution": false /* Report module resolution log messages. */,
"listEmittedFiles": false /* Print names of generated files part of the compilation. */,
"listFiles": false /* Print names of files part of the compilation. */,
"pretty": true /* Stylize errors and messages using color and context. */,

/* Experimental Options */
// "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
// "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,

"lib": ["es2017"],
"types": ["node"],
"typeRoots": ["node_modules/@types", "src/types"]
"noUnusedLocals": true,
"noUnusedParameters": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"traceResolution": false,
"listEmittedFiles": false,
"listFiles": false,
"pretty": true,
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules/**"],
"compileOnSave": false,
"typedocOptions": {
"entryPoints": ["src/index.ts"],
"out": "docs",
"out": "artifacts/docs",
"exclude": "**/*.test.ts"
}
}
2 changes: 1 addition & 1 deletion tsconfig.module.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"extends": "./tsconfig",
"compilerOptions": {
"target": "esnext",
"outDir": "build/module",
"outDir": "artifacts/build/module",
"module": "esnext"
},
"exclude": [
Expand Down

0 comments on commit e7e6ada

Please sign in to comment.