fix(index.ts): ensure replacement.from and replacement.to default to empty arrays

Author: AsifNawaz-cnic

.github/linters/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "target": "ES2022",
+    "outDir": "dist",
+    "declaration": true,
+    "declarationDir": "./dist",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "NodeNext"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules"]
+}

.github/workflows/release.yml

@@ -7,4 +7,4 @@ on:
 jobs:
   release:
     uses: centralnicgroup-opensource/rtldev-middleware-shareable-workflows/.github/workflows/semantic-release-replace-release.yml@main
-    secrets: inherit
+    secrets: inherit

.prettierignore

@@ -1,3 +1,4 @@
 dist/
 lib/
-node_modules/
+node_modules/
+HISTORY.md

.releaserc.json

@@ -2,27 +2,27 @@
   "ci": false,
   "branches": ["main"],
   "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      [
-          "@semantic-release/changelog",
-          {
-              "changelogFile": "HISTORY.md"
-          }
-      ],
-      [
-          "@semantic-release/git",
-          {
-              "assets": [
-                  "docs",
-                  "@(package?(-lock)|composer).json",
-                  "src/*",
-                  "dist/*",
-                  "(HISTORY|README|LICENSE).md"
-              ]
-          }
-      ],
-      "semantic-release-teams-notify-plugin",
-      "@semantic-release/github"
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "HISTORY.md"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "docs",
+          "@(package?(-lock)|composer).json",
+          "src/*",
+          "dist/*",
+          "(HISTORY|README|LICENSE).md"
+        ]
+      }
+    ],
+    "semantic-release-teams-notify-plugin",
+    "@semantic-release/github"
   ]
-}
+}

CONTRIBUTING.md

@@ -2,10 +2,10 @@
 
 **Table of contents**
 
-* [Contributor License Agreements](#contributor-license-agreements)
-* [Contributing a patch](#contributing-a-patch)
-* [Running the tests](#running-the-tests)
-* [Releasing the library](#releasing-the-library)
+- [Contributor License Agreements](#contributor-license-agreements)
+- [Contributing a patch](#contributing-a-patch)
+- [Running the tests](#running-the-tests)
+- [Releasing the library](#releasing-the-library)
 
 ## Contributor License Agreements
 
@@ -15,10 +15,10 @@ have to jump a couple of legal hurdles.
 Please fill out either the individual or corporate Contributor License Agreement
 (CLA).
 
-  * If you are an individual writing original source code and you're sure you
-    own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
-  * If you work for a company that wants to allow you to contribute your work,
-    then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
+- If you are an individual writing original source code and you're sure you
+  own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
+- If you work for a company that wants to allow you to contribute your work,
+  then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
 
 Follow either of the two links above to access the appropriate CLA and
 instructions for how to sign and return it. Once we receive it, we'll be able to
@@ -54,4 +54,4 @@ accept your pull requests.
         npm run lint
         npm run format
 
-[setup]: https://cloud.google.com/nodejs/docs/setup
+[setup]: https://cloud.google.com/nodejs/docs/setup

README.md

@@ -56,6 +56,7 @@ The following example uses this plugin to demonstrate using semantic-release in
   ]
 }
 ```
+
 ### Validation
 
 The presence of the `results` array will trigger validation that a replacement has been made. This is optional but recommended.

dist/index.js

@@ -47,8 +47,8 @@ export async function prepare(PluginConfig, context) {
         delete replacement.results;
         const replaceInFileConfig = {
             ...replacement,
-            from: replacement.from,
-            to: replacement.to,
+            from: replacement.from ?? [],
+            to: replacement.to ?? [],
         };
         // The `replace-in-file` package uses `String.replace` under the hood for
         // the actual replacement. If `from` is a string, this means only a

docs/README.md

@@ -28,9 +28,9 @@ semantic-release-replace-plugin
 
 #### Defined in
 
-[index.ts:26](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L26)
+[index.ts:26](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L26)
 
-___
+---
 
 ### FromCallback
 
@@ -42,30 +42,30 @@ ___
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `filename` | `string` |
-| `...args` | `unknown`[] |
+| Name       | Type        |
+| :--------- | :---------- |
+| `filename` | `string`    |
+| `...args`  | `unknown`[] |
 
 ##### Returns
 
 `RegExp` \| `string`
 
 #### Defined in
 
-[index.ts:27](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L27)
+[index.ts:27](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L27)
 
-___
+---
 
 ### To
 
 Ƭ **To**: `string` \| [`ToCallback`](README.md#tocallback)
 
 #### Defined in
 
-[index.ts:31](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L31)
+[index.ts:31](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L31)
 
-___
+---
 
 ### ToCallback
 
@@ -77,9 +77,9 @@ ___
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `match` | `string` |
+| Name      | Type        |
+| :-------- | :---------- |
+| `match`   | `string`    |
 | `...args` | `unknown`[] |
 
 ##### Returns
@@ -88,7 +88,7 @@ ___
 
 #### Defined in
 
-[index.ts:32](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L32)
+[index.ts:32](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L32)
 
 ## Functions
 
@@ -98,15 +98,15 @@ ___
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
+| Name           | Type                                         |
+| :------------- | :------------------------------------------- |
 | `PluginConfig` | [`PluginConfig`](interfaces/PluginConfig.md) |
-| `context` | `VerifyReleaseContext` |
+| `context`      | `VerifyReleaseContext`                       |
 
 #### Returns
 
 `Promise`\<`void`\>
 
 #### Defined in
 
-[index.ts:163](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L163)
+[index.ts:163](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L163)

docs/interfaces/PluginConfig.md

@@ -44,4 +44,4 @@ An array of replacements to be made.
 
 #### Defined in
 
-[index.ts:132](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L132)
+[index.ts:132](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L132)

docs/interfaces/Replacement.md

@@ -28,49 +28,49 @@ with the difference being the single string for `to` and `from`.
 
 #### Defined in
 
-[index.ts:87](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L87)
+[index.ts:87](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L87)
 
-___
+---
 
 ### countMatches
 
 • `Optional` **countMatches**: `boolean`
 
 #### Defined in
 
-[index.ts:88](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L88)
+[index.ts:88](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L88)
 
-___
+---
 
 ### disableGlobs
 
 • `Optional` **disableGlobs**: `boolean`
 
 #### Defined in
 
-[index.ts:89](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L89)
+[index.ts:89](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L89)
 
-___
+---
 
 ### dry
 
 • `Optional` **dry**: `boolean`
 
 #### Defined in
 
-[index.ts:91](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L91)
+[index.ts:91](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L91)
 
-___
+---
 
 ### encoding
 
 • `Optional` **encoding**: `string`
 
 #### Defined in
 
-[index.ts:90](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L90)
+[index.ts:90](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L90)
 
-___
+---
 
 ### files
 
@@ -80,9 +80,9 @@ files to search for replacements
 
 #### Defined in
 
-[index.ts:42](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L42)
+[index.ts:42](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L42)
 
-___
+---
 
 ### from
 
@@ -104,32 +104,32 @@ conversion rules as mentioned above.
 
 #### Defined in
 
-[index.ts:58](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L58)
+[index.ts:58](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L58)
 
-___
+---
 
 ### ignore
 
 • `Optional` **ignore**: `string`[]
 
 #### Defined in
 
-[index.ts:86](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L86)
+[index.ts:86](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L86)
 
-___
+---
 
 ### results
 
-• `Optional` **results**: \{ `file`: `string` ; `hasChanged`: `boolean` ; `numMatches?`: `number` ; `numReplacements?`: `number`  }[]
+• `Optional` **results**: \{ `file`: `string` ; `hasChanged`: `boolean` ; `numMatches?`: `number` ; `numReplacements?`: `number` }[]
 
 The results array can be passed to ensure that the expected replacements
 have been made, and if not, throw and exception with the diff.
 
 #### Defined in
 
-[index.ts:96](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L96)
+[index.ts:96](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L96)
 
-___
+---
 
 ### to
 
@@ -143,6 +143,7 @@ The context object is used to render the template. Additional values
 can be found at: https://semantic-release.gitbook.io/semantic-release/developer-guide/js-api#result
 
 For advanced replacement (NOTE: only for use with `release.config.js` file version), pass in a function to replace non-standard variables
+
 ```
 {
    from: `__VERSION__ = 11`, // eslint-disable-line
@@ -162,4 +163,4 @@ to match the amount of `from` matchers.
 
 #### Defined in
 
-[index.ts:85](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/17307cb/src/index.ts#L85)
+[index.ts:85](https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-replace-plugin/blob/a490964/src/index.ts#L85)