@codiac.io/codiac-messaging NPM

Introduction

TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.

Getting Started

TODO: Guide users through getting your code up and running on their own system. In this section you can talk about: 1. Installation process 2. Software dependencies 3. Latest releases 4. API references

Build and Test

TODO: Describe and show how to build your code and run the tests.

Contribute

TODO: Explain how other users and developers can contribute to make your code better.

If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:

Initial Setup

Tyepscript

tsc --init

Copy the default tsconfig.json:

{
  "compilerOptions": {
    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es6", 
    /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
    "module": "commonjs", 
    /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
    "lib": [
      "es6",
      "dom"
    ], 
    /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    "declaration": true, 
    /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    "sourceMap": true, 
    /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./dist", 
    /* Redirect output structure to the directory. */
    "rootDir": "./src", 
    /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    "skipLibCheck": true, 
    /* Prevents tsc from validating code inside dependencies (in node-modules folder). */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
    /* Strict Type-Checking Options */
    "strict": true, 
    /* Enable all 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. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "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. */
    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    "types": [
      "node",
      "reflect-metadata"
    ], /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "resolveJsonModule": true,
    "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
    /* Experimental Options */
    "useUnknownInCatchVariables": false,
    "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
    "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */
  },
  "ts-node": {
    "compilerOptions": {
      "module": "CommonJS"
    }
  },
  "include": [
    "./src"
  ],
  "exclude":  [
    "src/**/*.spec.ts",
    "src/**/__tests__/**",
    "src/**/test/**"
  ]
}

VS Code

Declare typescript test file name spec in ./.vscode/settings.json

{
  ...
  "mocha.files.glob": "./**/test/**/*.spec.ts",
  "mocha.requires": [
    "ts-node/register",
    "reflect-metadata"
  ],
  ...
}

NPM

Initialize with defaults

npm init

Install these dev packages

npm i --save-dev 
  typescript@4.9.5 \
  chai@4.3.6 \
  chai-as-promised@8.0.1 \
  mocha@10.0.0 \
  nyc \
  npm-run-all@4.1.5 \
  sinon@14.0.0 \
  ts-mocha@10.0.0 \
  ts-node@10.9.1 \
  ts-sinon@2.0.2 \
  @types/chai@4.3.3 \
  @types/chai-as-promised@8.0.2 \
  @types/expect@24.3.0 \
  @types/mocha@9.1.1 \
  @types/node@18.7.6

npm i reflect-metadata

{ 
  "scripts: {    
    "build": "tsc -p .",
    "test": "ts-mocha --paths -p tsconfig.json src/**/*.spec.ts"
  }
}

gitignore

(from default "node" gitignore via az devops) Add these lines

# CODIAC CUSTOM
**/adhoc*.*
**/adhoc*/**/*
.codiac-user
*.npmrc
yalc.lock
.yalc

NOTE: (consider `dotenvx run --env-file=.env.test -- ts-mocha --paths -p tsconfig.test.json src/**/.spec.ts` for testing command)*

Linting

npm i --save-dev \
  prettier@3.4.2 \
  eslint@9.18.0 \
  eslint-config-prettier@10.0.1 \
  eslint-plugin-prettier@5.2.2 \
  @typescript-eslint/eslint-plugin \
  @typescript-eslint/parser

npm upgrade

create this file in the root: eslinterc.json

{
  "root": true,
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"],
  "extends": [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended"
  ],
  "parserOptions": {
    "ecmaVersion": 2020,
    "sourceType": "module"
  },
  "env": {
    "node": true,
    "es6": true
  },
  "ignorePatterns": [
    "dist/",
    "node_modules/",
    "src/**/*.spec.ts",
    "src/**/__tests__/**",
    "src/**/test/**"
  ],
  "rules": {
    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
    "@typescript-eslint/explicit-module-boundary-types": "off"
  }
}

Codiac

cod init .

Build Pipelines

Lift and shift from codiac-domain/azure-pipelines.yml as template.
(Remove the copy and paste of the package.json into the dist folder on build - not needed)
(Remove ./dist from any publish commands)
Write to root file: azure-pipelines.yml
Go to azure devops and add the pipeline from existing file.