Initial commit

Author: JDIZM

.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+env.d.ts
+```

.eslintrc.js

@@ -0,0 +1,46 @@
+module.exports = {
+  root: true,
+  env: {
+    es2021: true,
+    node: true
+  },
+  extends: [
+    // By extending from a plugin config, we can get recommended rules without having to add them manually.
+    "eslint:recommended",
+    "plugin:import/recommended",
+    "plugin:@typescript-eslint/recommended",
+    // This disables the formatting rules in ESLint that Prettier is going to be responsible for handling.
+    // Make sure it's always the last config, so it gets the chance to override other configs.
+    "eslint-config-prettier",
+    "prettier"
+  ],
+  settings: {
+    // Tells eslint how to resolve imports
+    "import/resolver": {
+      alias: {
+        map: [["@", "./src"]],
+        extensions: [".ts", ".js", ".jsx", ".tsx", ".json"]
+      },
+      node: {
+        paths: ["./src"],
+        extensions: [".js", ".jsx", ".ts", ".tsx"]
+      }
+    },
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"]
+    }
+  },
+  rules: {
+    // Add your own rules here to override ones from the extended configs.
+    "@typescript-eslint/no-explicit-any": "warn"
+  },
+  overrides: [
+    {
+      files: ["**/__mocks__/*", "**/*.{test,tests}.{ts,tsx}"], // Feels unnecessary to enforce these rules in tests
+      rules: {
+        "@typescript-eslint/no-unused-vars": 0,
+        "@typescript-eslint/no-explicit-any": 0
+      }
+    }
+  ]
+};

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+coverage

.prettierignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+coverage/

.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  trailingComma: "none",
+  tabWidth: 2,
+  semi: true,
+  singleQuote: false,
+  printWidth: 120,
+  bracketSpacing: true,
+  endOfLine: "lf"
+};

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "workbench.colorTheme": "Darcula",
+  "workbench.iconTheme": "material-icon-theme",
+  "editor.fontFamily": "JetBrains Mono",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

README.md

@@ -0,0 +1,50 @@
+# vite-node-ts-starter
+
+- [vite-node](https://github.com/vitest-dev/vitest/tree/main/packages/vite-node)
+- [esbuild](https://esbuild.github.io/)
+- [eslint](https://eslint.org/)
+- [prettier](https://prettier.io/)
+- [typescript](https://www.typescriptlang.org/)
+- [vitest](https://vitest.dev/)
+
+A few things to understand
+
+1. building with esbuild
+2. building with the typescript compiler
+
+Importing the package.json makes the tsc compiler bundle the /src folder into the /dist folder. To keep these two build options working together esbuild is configured to nest the output in /src folder too.
+
+Have a play around with the configuration and build options to suit the project.
+
+This is a work in progress template and welcome to feedback.
+
+## Requirements
+
+This project requires node.js to be installed. This project uses volta to manage node versions.
+
+To install volta run the following command in the terminal.
+
+```
+curl https://get.volta.sh | bash
+```
+
+### ESM Node
+
+https://www.typescriptlang.org/docs/handbook/esm-node.html
+
+### Install
+
+Build and install the package globally so you have access in your cli terminal.
+
+1. build `npm run build:es`
+2. install `npm install -g .`
+
+Then test the package is working and installed by calling the package name `pkg-name` in your terminal.
+
+### Testing
+
+This project uses [vitest](https://vitest.dev/) for testing.
+
+1. run the unit tests with `npm run test`
+
+It's also recommended to install the [vitest extension for vscode](https://marketplace.visualstudio.com/items?itemName=ZixuanChen.vitest-explorer).

build.mjs

@@ -0,0 +1,24 @@
+import { build } from "esbuild";
+
+// https://janessagarrow.com/blog/typescript-and-esbuild/
+const sharedConfig = {
+  entryPoints: ["src/index.ts"],
+  bundle: true,
+  minify: true,
+  sourcemap: true,
+  target: "node16"
+};
+
+build({
+  ...sharedConfig,
+  platform: "node",
+  outfile: "dist/src/index.js",
+  format: "cjs"
+});
+
+build({
+  ...sharedConfig,
+  outfile: "dist/src/index.esm.js",
+  platform: "node",
+  format: "esm"
+});