chore: prepare to v1

.github/workflows/ci.yml

@@ -67,6 +67,5 @@ jobs:
         id: process
         with:
             rootDir: './example'
-
         env:
           EXAMPLE: 'World'

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "gh-action-example",
+  "name": "prp-preprocessor",
   "version": "1.0.0",
-  "description": "",
+  "description": "A GitHub Action that preprocesses files",
   "main": "index.js",
   "scripts": {
     "clean": "rimraf dist pnpm-lock.yaml node_modules",
@@ -13,13 +13,23 @@
     "lint": "eslint --cache --cache-strategy content --report-unused-disable-directives .",
     "package": "pnpm ncc build src/index.ts -o dist --source-map --license licenses.txt",
     "package:watch": "pnpm run package --watch",
-    "test": "pnpm jest --coverage --verbose",
+    "test": "pnpm jest --coverage",
     "prepublishOnly": "pnpm run clean && pnpm install && pnpm run build",
-    "preflight": "pnpm install && pnpm run format:write && pnpm run lint && pnpm run test && pnpm run package",
+    "preflight": "pnpm install && pnpm run format:write && pnpm run lint && pnpm run package",
     "prepare": "husky"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "github",
+    "action",
+    "preprocessor",
+    "replace",
+    "variables"
+  ],
+  "author": "Breno A.",
+  "homepage": "https://github.com/CIFriends/prp-preprocessor#readme",
+  "bugs": {
+    "url": "https://github.com/CIFriends/prp-preprocessor/issues"
+  },
   "license": "Apache-2.0",
   "packageManager": "[email protected]",
   "jest": {

src/utils/ExtensionFilter.ts

@@ -72,15 +72,6 @@ export function getFilesByExtension(params: GetFilesParams): string[] {
   }
 }
 
-interface GetFilesParams {
-  dir: string;
-  extension: string;
-  includeSubDir?: boolean;
-  ignoredDir?: string[];
-  fsModule?: typeof fs;
-  pathModule?: typeof path;
-}
-
 /**
  * Generate a regular expression with a wildcard pattern
  * @param extension
@@ -100,3 +91,12 @@ const ignoredDefault: string[] = [
   ".vscode",
   ".idea"
 ];
+
+interface GetFilesParams {
+  dir: string;
+  extension: string;
+  includeSubDir?: boolean;
+  ignoredDir?: string[];
+  fsModule?: typeof fs;
+  pathModule?: typeof path;
+}

src/utils/FileProcessor.ts

@@ -1,5 +1,9 @@
 import fs from "fs";
 
+/**
+ * Process files and replace variables
+ * @param params - Files parameters see {@link FilesParams}
+ */
 export function processFiles(params: FilesParams): void {
   const { files, encodings, variables, fsModule = fs, extension } = params;
 
@@ -23,6 +27,12 @@ export function processFiles(params: FilesParams): void {
   }
 }
 
+/**
+ * Replace variables in content
+ * @param variables - Map of variables
+ * @param content - Content to replace variables
+ * @returns {string} Content with replaced variables
+ */
 export function replaceVariables(
   variables: Map<string, string>,
   content: string

src/utils/VariableManager.ts

@@ -16,6 +16,10 @@ export function getEnvVariables(ignored: string[]): Map<string, string> {
   );
 }
 
+/**
+ * Get all input parameters
+ * @returns {InputParams} Input parameters
+ */
 export function getInputParams(): InputParams {
   const rootDir: string = core.getInput("rootDir", required);
   const extension: string = core.getInput("extension", required);