Merge branch 'develop'

Author: WhereJuly

.delivery/.temp/.tsbuildinfo

@@ -0,0 +1,30 @@
+{
+    "compilerOptions": {
+        "target": "es2022", // Compile to ES2020 JavaScript (modern browsers)
+        "module": "NodeNext", // Use ES2020 modules (import/export)
+        "moduleResolution": "NodeNext", // Resolve modules in a way that supports ESM and modern resolution strategies
+        "strict": true, // Enable strict type-checking options
+        "esModuleInterop": true, // Enable interoperability between CommonJS and ES modules
+        "skipLibCheck": true, // Skip type checking of declaration files for faster builds
+        "forceConsistentCasingInFileNames": true, // Ensure consistent casing in file names
+        "baseUrl": "../../",
+        "rootDir": "../../src",
+        "paths": {
+            "@src/*": ["./src/*"]
+        },
+        "resolveJsonModule": true,
+        "outDir": "../.builds/dist/code",
+        "declarationDir": "../.builds/dist/types",
+        "declaration": true, // Generate `.d.ts` declaration files
+        "declarationMap": true, // Generate map files for declarations
+        "sourceMap": true, // Generate source maps
+        "lib": ["es2022"], // Include ES2020 features (e.g., BigInt, Nullish Coalescing)
+        "skipDefaultLibCheck": true // Skip checking default lib files (faster builds)
+    },
+    "include": [
+        "../../src/**/*.ts" // Include all TypeScript files in the "src" directory
+    ],
+    "exclude": [
+        "node_modules" // Exclude node_modules directory
+    ]
+}

.delivery/configuration/tsconfig.json

@@ -0,0 +1,28 @@
+'use strict';
+
+import { execSync } from 'child_process';
+
+const commands: string[] = [
+    'npm run test:foundation',
+    'npm run lint',
+    "npm run package:lint:readme",
+    'rimraf ./.delivery/.builds/dist',
+    'tsc -p ./.delivery/configuration/tsconfig.json',
+    'npm run package:de-alias',
+    'npm run package:bundle:copy',
+    'npm run package:pack',
+    'npm run package:test:usage',
+];
+
+try {
+    commands.forEach((cmd) => {
+        console.log(`Running: ${cmd}`);
+        execSync(cmd, { stdio: 'inherit' });
+    });
+} catch (_error) {
+    const error = _error as Error;
+
+    console.error(`Error running command: ${error.message}`);
+
+    process.exit(1);
+}

.delivery/scripts/build.ts

@@ -0,0 +1,82 @@
+name: null-object package test with coverage
+
+on:
+  push:
+    branches:
+      # - never # Skip the workflow for debugging purposes;
+      # - implement/package-ci # NB: For debugging only
+      - develop
+      - master
+    paths:
+      - ".github/workflows/null-object.yml"
+      - "readme.md"
+      - "package.json"
+      - "src/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    env:
+      GITHUB_AUTH_TOKEN: ${{ secrets.GH_AUTH_TOKEN }} # NB: Cannot use 'GITHUB_' prefix
+
+    name: Test, publish coverage
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node 20
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      #  Install dependencies and build the package to test in .usage folder
+      - name: Install dependencies and build the package
+        run: |
+          npm install
+          cd .usage && npm install
+          cd ../
+          npm run package:build
+
+      - name: Testing the latest build at usage .usage subfolder
+        working-directory: ./.usage
+        run: |
+          npm install
+          npm run test:usage
+
+      - name: Run tests and collect coverage
+        # NB: See https://app.codecov.io/gh/WhereJuly/60-1-oas-markdown-merger/tests/new
+        # NB: See https://app.codecov.io/gh/WhereJuly/60-1-oas-markdown-merger/new
+        run: npm run test:foundation -- --coverage
+
+      # I need this step only run for the paths mentioned above AND for only `master` branch;`
+      # create and push the `<package-name>@v<package-version>` tag to the monorepo
+      # Take the package name and version from package.json
+      - name: Create and push tag on master branch only
+        # NB: For debugging
+        # if: github.ref_name == 'implement/package-ci'
+        if: github.ref_name == 'master'
+        run: |
+          # Extract package name and version from package.json
+          PACKAGE_NAME=$(jq -r .name package.json)
+          PACKAGE_VERSION=$(jq -r .version package.json)
+
+          # Create the tag
+          # TAG="${PACKAGE_NAME}@${PACKAGE_VERSION}" # Only for monorepos
+          TAG="${PACKAGE_VERSION}"
+          git tag $TAG
+
+          # Push the tag to the repository
+          git push origin $TAG
+
+      # - name: Push the package subtree to a dedicated repo
+      # NB: See the code for this step in https://lean-web-enterprise.atlassian.net/browse/DCPLDOAS-68
+
+      - name: Upload coverage reports to Codecov
+        # NB: For debugging
+        # if: github.ref_name == 'implement/package-ci'
+        if: github.ref_name == 'master'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: WhereJuly/68-null-object

.github/workflows/null-object.yml

@@ -1,6 +1,8 @@
 # build output
 dist/
 .builds
+.delivery/.temp
+.coverage
 
 # dependencies
 node_modules/

.gitignore

@@ -0,0 +1,3 @@
+'use strict';
+
+console.log('dummy');

.usage/examples.ts

@@ -0,0 +1,17 @@
+{
+    "name": "usage",
+    "version": "0.0.0",
+    "description": "The internal usage package is a part of parent package to independently test the parent package usage as an external dependency.",
+    "main": "index.ts",
+    "type": "module",
+    "private": true,
+    "scripts": {
+        "test:usage": "npm install && npm run types:check && vitest run --config tests/vitest.config.ts",
+        "types:check": "npx tsc --noEmit --project .",
+        "pre-push": "npm run test:usage"
+    },
+    "license": "UNLICENSED",
+    "dependencies": {
+        "@wherejuly/null-object": "file:../.delivery/.builds/dist"
+    }
+}

.usage/package-lock.json

@@ -0,0 +1,40 @@
+'use strict';
+
+import { describe, expect, it } from 'vitest';
+
+import { noop, nullObject } from '@wherejuly/null-object';
+
+describe('Null-Object & noop Function Usage Test', () => {
+
+    it('Should access properties or methods on Null-Object', () => {
+        const actual = nullObject();
+
+        expect(actual.dummy).toBeInstanceOf(Function);
+        expect(actual.dummy.another).toBeInstanceOf(Function);
+        expect(actual.dummy().another.more()).toBeInstanceOf(Function);
+        expect(actual.method()).toBeInstanceOf(Function);
+        expect(actual.method(123).another('abc')).toBeInstanceOf(Function);
+    });
+
+    it('Should be able to silently accept assignments to properties', () => {
+        const actual = nullObject<{ dummy: any; }>();
+
+        actual.dummy = 123;
+        actual.dummy.another = 'abc';
+
+        expect(actual.dummy).toBeInstanceOf(Function);
+        expect(actual.dummy.another).toBeInstanceOf(Function);
+    });
+
+    it('Should output a custom null-object identity name', () => {
+        const fixture = 'Fixture name';
+        const actual = nullObject(fixture);
+
+        expect(actual.toString()).toEqual(`[NullObject: ${fixture}]`); // NOSONAR
+    });
+
+    it('noop: Should accept any arguments without throwing', () => {
+        expect(() => noop(1, 'a', true, null)).not.toThrow();
+    });
+
+});

.usage/package.json

@@ -0,0 +1,32 @@
+'use strict';
+
+import { fileURLToPath, pathToFileURL } from 'node:url';
+import { cwd } from 'node:process';
+import { configDefaults, defineConfig } from 'vitest/config';
+
+const root = pathToFileURL(cwd()).toString();
+
+export default defineConfig({
+    plugins: [],
+    resolve: {
+        alias: {
+            '@tests': fileURLToPath(new URL(`${root}/tests`, import.meta.url)),
+        }
+    },
+    test: {
+        /**
+         * WARNING: To prevent tests hanging.
+         * @see https://vitest.dev/guide/common-errors.html#failed-to-terminate-worker
+         */
+        pool: 'forks',
+        fileParallelism: false,
+        cache: false,
+        reporters: ['verbose'],
+        globals: true,
+        exclude: configDefaults.exclude,
+        root: fileURLToPath(new URL('./', import.meta.url)),
+        chaiConfig: {
+            truncateThreshold: 200
+        }
+    }
+});