STAT-12: initial build

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+# jira ticket
+
+https://dereckmezquita.atlassian.net/browse/<TICKET-ID>
+
+# todo list
+
+- [ ] Version bump
+- [ ] Clean up code
+
+# tests updated
+
+- [ ] integration test

.github/workflows/npm_publish_dev.yml

@@ -0,0 +1,41 @@
+name: Node.js Package Dev Release
+
+on:
+  push:
+    branches-ignore:
+      - 'master'
+
+jobs:
+  build-and-publish-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run tests
+        run: yarn test
+
+      - name: Get current version
+        id: package-version
+        uses: martinbeentjes/[email protected]
+
+      - name: Generate unique version
+        id: generate-version
+        run: |
+          current_version=$(echo ${{ steps.package-version.outputs.current-version}} | sed 's/-dev\.[0-9]\+$//')
+          timestamp=$(date +%Y%m%d%H%M%S)
+          echo "new_version=${current_version}-dev.${timestamp}" >> $GITHUB_OUTPUT
+
+      - name: Update version
+        run: npm version ${{ steps.generate-version.outputs.new_version }} --no-git-tag-version
+
+      - name: Publish to npm
+        run: npm publish --tag dev
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/npm_publish_prod.yml

@@ -0,0 +1,20 @@
+name: Node.js Package Production Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-and-publish-prod:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: yarn install --frozen-lockfile
+      - run: yarn test
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,24 @@
+# dev
+ignore/
+*.ignore.*
+*.ignore
+*.sensitive.*
+*.sensitive
+.env
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# build files
+build/
+dist/
+
+# dependencies
+node_modules/
+
+# platform
+.DS_Store

.husky/commit-msg

@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+
+branch_name=$(git branch --show-current)
+ticket_number=$(echo "$branch_name" | grep -oE '^[A-Za-z]+-[0-9]+')
+
+if [ ! -z "$ticket_number" ]; then
+    commit_msg=$(tr -d '\n' < "$1")
+    new_commit_msg="$ticket_number: $commit_msg"
+    echo "$new_commit_msg" > "$1"
+fi

.husky/pre-commit

@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+
+# Get list of initially staged files
+initially_staged_files=$(git diff --cached --name-only --diff-filter=ACM | tr '\n' ' ')
+
+# Run Prettier on the entire project
+yarn run format
+# yarn run test
+
+# If there were initially staged files, re-stage only those files
+if [ -n "$initially_staged_files" ]; then
+    echo "$initially_staged_files" | xargs git add
+else
+    echo "No files were initially staged."
+fi
+
+echo "pre-commit hook complete."

.prettierignore

@@ -0,0 +1,11 @@
+*.html
+*.md
+
+# Ignore specific directory
+dev/
+
+# Ignore all JSON files
+*.json
+
+# Ignore specific file
+src/ignore-this-file.ts

TODO.md

@@ -0,0 +1 @@
+# todo

jest.config.ts

@@ -0,0 +1,12 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    // Specify test files pattern
+    testMatch: ['**/test/**/*.ts', '**/?(*.)+(spec|test).ts'],
+    // Module file extensions for importing
+    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node']
+};
+
+export default config;

package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@ts-statscript/helpers",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ts-statscript/helpers.git"
+  },
+  "author": {
+    "name": "Dereck Mezquita",
+    "email": "[email protected]"
+  },
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "yarn run clean && tsc",
+    "prepublishOnly": "yarn run build",
+    "publishAlpha": "npm version prerelease --preid=dev --no-git-tag-version && yarn build && yarn publish --tag dev --non-interactive",
+    "format": "prettier --write .",
+    "test": "jest"
+  },
+  "prettier": {
+    "semi": true,
+    "trailingComma": "none",
+    "singleQuote": true,
+    "printWidth": 80,
+    "tabWidth": 4,
+    "useTabs": false,
+    "overrides": [
+      {
+        "files": "*.yml",
+        "options": {
+          "tabWidth": 2
+        }
+      }
+    ]
+  },
+  "dependencies": {
+    "@ts-statscript/base": "^0.0.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.26",
+    "husky": "^9.1.5",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2"
+  }
+}

src/index.ts

@@ -0,0 +1,3 @@
+export function helloWorld() {
+    return 'Hello, World!';
+}

src/processArrNaN.ts

@@ -0,0 +1,42 @@
+/**
+ * Helper function to handle NaN values in an array.
+ *
+ * By default, the function does not remove NaN values and returns null if NaN values are found.
+ *
+ * @param array - The numeric array to be checked.
+ * @param rmNaN - Boolean indicating how to handle NaN values. If true, NaN values are removed from the array, if false the function returns null as soon as a NaN value is found.
+ * @param verbose - A boolean indicating whether to log the NaN values found. Default is false.
+ * @returns The cleaned array if rmNaN is true, or null if NaN values are found and rmNaN is false.
+ */
+export function processArrNaN(
+    array: number[],
+    rmNaN: boolean = false,
+    verbose: boolean = false
+): number[] | null {
+    const result: number[] = new Array(array.length);
+    let last_non_NaN = 0;
+    let hasNaN = false;
+
+    for (let i = 0; i < array.length; i++) {
+        const value = array[i];
+        if (Number.isNaN(value)) {
+            hasNaN = true;
+            if (!rmNaN) {
+                if (verbose) {
+                    console.warn('Array contains a NaN value at position:', i);
+                }
+                return null; // Early exit if NaN found and rmNaN is false
+            }
+            if (verbose) {
+                console.warn('Array contains a NaN value at position:', i);
+            }
+        } else {
+            result[last_non_NaN++] = value; // Assign and increment in one step
+        }
+    }
+
+    // Resize the array to the number of valid elements found
+    result.length = last_non_NaN;
+
+    return hasNaN ? result : array; // Return the original array if no NaN was found
+}

test/helloWorld.test.ts

@@ -0,0 +1,7 @@
+import { helloWorld } from '../src';
+
+describe('helloWorld', () => {
+    it('returns "Hello, World!"', () => {
+        expect(helloWorld()).toBe('Hello, World!');
+    });
+});

tsconfig.json

@@ -0,0 +1,111 @@
+{
+    "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": "es2020" /* 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 legacy experimental 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": "commonjs" /* Specify what module code is generated. */,
+        "rootDir": "./src" /* Specify the root folder within your source files. */,
+        // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+        // "baseUrl": "./",                                  /* 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. */
+        // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+        // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+        // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+        // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+        // "resolveJsonModule": true,                        /* Enable importing .json files. */
+        // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+        // "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. */,
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "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. */
+        // "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. */
+        // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+        // "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. */
+    },
+    "include": ["src/**/*.ts"],
+    "exclude": ["node_modules"]
+}