Merge pull request #26 from jfrazx/develop

feat: executor property

.github/workflows/codeql-analysis.yml

@@ -1,34 +1,40 @@
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ master ]
+    branches: ['master', 'develop']
   pull_request:
-    branches: [ master ]
+    branches: ['master', 'develop']
   schedule:
     - cron: '33 20 * * 4'
 
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-latest
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
 
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
 
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: '/language:${{matrix.language}}'

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+
+on:
+  workflow_run:
+    workflows: ['Snyk Security Check', 'Tests']
+    branches: [master]
+    types:
+      - completed
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      packages: write
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.github/workflows/snyk.yml

@@ -0,0 +1,11 @@
+name: Snyk Security Check
+on: [push, pull_request]
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - name: Run Snyk to check for vulnerabilities
+        uses: snyk/actions/node@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: |
+          npm ci
+          npm test

.gitignore

@@ -1,4 +1,3 @@
-
 *.map
 *.js
 *.log
@@ -9,11 +8,14 @@ logs
 *.lcov
 
 !examples/**/*
-dist/
 build/
+dist/
 
+build-examples/
+.parcel-cache/
 node_modules/
 .nyc_output/
 coverage/
+.yarn/
 
 */.DS_Store

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run coverage:test

.husky/prepare-commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+exec < /dev/tty && npx cz --hook || true

.npmignore

@@ -11,19 +11,27 @@ tslint.json
 .prettierrc
 .releaserc
 .nycrc.json
+cspell.json
 *.lcov
+.yarnrc.yml
 yarn.lock
-mocha.opts
 
-.nyc_output/
+.env.*
 
 !*.d.ts
 
 typings/
 node_modules/
+examples/
+build-examples/
 spec/
-src/
 test/
+docs/
+scripts/
+.nyc_output/
 .vscode/
-coverage/
+.yarn/
 .github/
+coverage/
+.husky/
+.parcel-cache/

.nycrc.json

@@ -1,18 +1,18 @@
 {
+  "require": ["ts-node/register", "source-map-support/register"],
   "extends": "@istanbuljs/nyc-config-typescript",
-  "check-coverage": true,
-  "lines": 99,
+  "reporter": ["lcov", "text-summary", "html"],
+  "tmp-directory": ".nyc_output",
+  "extension": [".ts", ".tsx"],
   "produce-source-map": true,
+  "report-dir": "./coverage",
+  "check-coverage": true,
   "statements": 99,
   "functions": 99,
   "branches": 87,
-  "all": false,
   "cache": true,
-  "report-dir": "./coverage",
-  "extension": [".ts", ".tsx"],
-  "tmp-directory": ".nyc_output",
-  "reporter": ["lcov", "text-summary", "html"],
-  "require": ["ts-node/register", "source-map-support/register"],
+  "all": false,
+  "lines": 99,
   "exclude": [
     "test/**/*",
     "**/*.d.ts",

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Jason Franz <jfrazx> staringblind at gmail.com
+Copyright (c) 2023 jfrazx
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -127,16 +127,16 @@ expect(array[1]).to.equal(7);
 
 All options have default values.
 
-|    Option    | Default Value | Description                                                                                  |
-| :----------: | :-----------: | -------------------------------------------------------------------------------------------- |
-|     wrap     |      {}       | The object to wrap                                                                           |
-| shallowCopy  |     true      | Only create shallow copies of `defaultValue` objects                                         |
-| setUndefined |     false     | Set undefined values with `defaultValue`                                                     |
-| defaultValue |   undefined   | The value to return if resolved value is undefined                                           |
-| setCriteria  |  () => false  | Function that can override value to be set with the `defaultValue`                           |
-|   execute    |     false     | If true and `defaultValue` is a function it will be executed and the result returned         |
-|    noCopy    |     false     | Indicates if non-primitive default values should be returned as-is                           |
-| reuseMapKey  |     true      | If true and default value is a Map the key will be reused, otherwise shallowCopy rules apply |
+|    Option    | Default Value | Description                                                                                                            |
+| :----------: | :-----------: | ---------------------------------------------------------------------------------------------------------------------- |
+|     wrap     |      {}       | The object to wrap                                                                                                     |
+| shallowCopy  |     true      | Only create shallow copies of `defaultValue` objects                                                                   |
+| setUndefined |     false     | Set undefined values with `defaultValue`                                                                               |
+| defaultValue |   undefined   | The value to return if resolved value is undefined                                                                     |
+| setCriteria  |  () => false  | Function that can override value to be set with the `defaultValue`                                                     |
+|   execute    |     false     | If true and `defaultValue` is a function it will be executed and the result returned. Receives property being accessed |
+|    noCopy    |     false     | Indicates if non-primitive default values should be returned as-is                                                     |
+| reuseMapKey  |     true      | If true and default value is a Map the key will be reused, otherwise shallowCopy rules apply                           |
 
 ---