feat: rename escape-paths to safe-output (#1029)

tj-actions · May 4, 2024 · be06119 · be06119
1 parent 3101549
commit be06119
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -158,17 +158,17 @@ jobs:
           
       - name: Run glob for source-files.txt escape paths
         uses: ./
-        id: glob-source-files-escape-paths
+        id: glob-source-files-safe-output
         with:
           files-from-source-file: |
             src/__tests__/source-files.txt
             src/__tests__/source-files.txt
-          escape-paths: true
+          safe-output: true
 
       - name: Show output
         run: |
-          echo "${{ steps.glob-source-files-escape-paths.outputs.paths }}"
-          cat "${{ steps.glob-source-files-escape-paths.outputs.paths-output-file }}"
+          echo "${{ steps.glob-source-files-safe-output.outputs.paths }}"
+          cat "${{ steps.glob-source-files-safe-output.outputs.paths-output-file }}"
 
       - name: Run glob for source-files.txt
         uses: ./

diff --git a/action.yml b/action.yml
@@ -53,7 +53,7 @@ inputs:
     description: 'Separator used for the paths output.'
     required: true
     default: " "
-  escape-paths:
+  safe-output:
     description: 'Escape special characters of filenames used in the `paths` output'
     required: false
     default: "true"

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/__tests__/main.test.ts b/src/__tests__/main.test.ts
@@ -12,7 +12,7 @@ const defaultEnv = {
   'INPUT_FOLLOW-SYMBOLIC-LINKS': 'true',
   'INPUT_MATCH-DIRECTORIES': 'true',
   'INPUT_MATCH-GITIGNORE-FILES': 'true',
-  'INPUT_ESCAPE-PATHS': 'false',
+  'INPUT_SAFE-OUTPUT': 'false',
   'INPUT_HEAD-REPO-FORK': 'false',
   INPUT_SEPARATOR: ' ',
   'INPUT_STRIP-TOP-LEVEL-DIR': 'true',

diff --git a/src/main.ts b/src/main.ts
@@ -62,7 +62,7 @@ export async function run(): Promise<void> {
     trimWhitespace: false
   })
   const diff = core.getInput('diff', {required: false})
-  const escapePaths = core.getBooleanInput('escape-paths', {required: false})
+  const safeOutput = core.getBooleanInput('safe-output', {required: false})
   const stripTopLevelDir = core.getBooleanInput('strip-top-level-dir', {
     required: true
   })
@@ -270,7 +270,7 @@ export async function run(): Promise<void> {
     )
   }
 
-  if (escapePaths) {
+  if (safeOutput) {
     paths = new Set([...paths].map(p => escapeString(p)))
   }