[01 - Node.js base template] #template #env

!nodejs_base_template.md

Params

Parameter	Default	Description
PROJECT_NAME	FOLDER_NAME	Name of current folder
PACKAGE_NAME	PROJECT_NAME	Package name
PKG_PUBLISH_CONFIG	undefined	restricted or public for scoped packages
PROJECT_DESCRIPTION		Description
AUTHOR	Vitaliy V. Makeev
LICENCE	MIT

#globals.js

global.FOLDER_NAME = __dirname // TODO

#scripts.sh

npm i -D @types/node@20 prettier dotenv auto-changelog envalid && git init

{1}.editorconfig

root = true

[*]
indent_style = space
indent_size = 2
charset = utf-8
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true

{1}[.vscode]launch.json

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Launch JS",
      "skipFiles": ["<node_internals>/**"],
      "envFile": "${workspaceFolder}/.env",
      "program": "${file}",
      "internalConsoleOptions": "openOnSessionStart",
      "outputCapture": "std"
    }
  ]
}

{1}[.vscode]settings.json

{
  "files.exclude": {
    "node_modules": true
  },
  "explorer.autoRevealExclude": {
    "**/node_modules": true
  },
  "editor.formatOnSave": true,
  "editor.formatOnPaste": false,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "editor.formatOnSaveMode": "file"
}

{2}.gitignore

.DS_Store

# Logs
logs
*.log
npm-debug.log*

# npm
node_modules

# env
.env*
!.env.example

# temp
/__temp

{3}.env

DEBUG=true

{3}.env.example

DEBUG=

{3}[src]env.js

import { cleanEnv, num, str } from "envalid";

export const env = cleanEnv(process.env, {
  FOO: str(),
  BAR: num({ default: 0 }),
});

{4}README.md

%PROJECT_NAME%

%PROJECT_DESCRIPTION%

{5}package.json{template}

{
  "name": "%PACKAGE_NAME%",	
  "version": "0.0.0",	
  "description": "%PROJECT_DESCRIPTION%",
  "scripts": {
    "env:example": "npx [email protected]",
    "test": "echo 'No tests'",
    "version": "npm run env:example && auto-changelog -p && git add CHANGELOG.md .env.example",
    "release": "np"
  },
  "publishConfig": {
    "access": "%PKG_PUBLISH_CONFIG%"
  },
  "engines": {
    "node": ">=14"
  },
  "prettier": {
    "semi": false,
    "singleQuote": true,
    "quoteProps": "consistent",
    "trailingComma": "none",
    "arrowParens": "avoid"
  },
  "np": {
    "yarn": false
  },
  "author": {
  	"name": "%AUTHOR%",
    "email": "%AUTHOR_EMAIL%"
  },
  "license": "%LICENCE%"	
}

{6}tsconfig.json

{
  "compilerOptions": {
    "lib": [
      "ES2021"
    ],
    "noEmit": true,
    "strict": true,
    "allowJs": true,
    "alwaysStrict": true,
    "checkJs": true,
    "moduleResolution": "Node",
    "module": "CommonJS"
  },
  "include": [
    "./**/*"
  ]
}

{99}some.json{action(trimLf=true,opt=1)}{next}.json

{
  "a": "b"
}