├── .github └── workflows │ └── test.yml ├── .gitignore ├── .nvmrc ├── LICENSE ├── README.md ├── action.yml ├── ci └── test-output │ └── out.js ├── dist ├── index.d.ts └── index.js ├── package-lock.json ├── package.json ├── src └── index.ts └── tsconfig.json /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: [master] 6 | pull_request: 7 | branches: [master] 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: set .bashrc path 14 | shell: bash 15 | run: | 16 | echo -n "test 17 | test" > $HOME/file 18 | echo "FILE_PATH=$HOME/file" > $GITHUB_ENV 19 | - uses: Erisa/write-file-action@master 20 | with: 21 | path: ${{ env.FILE_PATH }} 22 | contents: | 23 | echo "Hello World!" 24 | write-mode: append-newline 25 | - uses: actions/upload-artifact@v4 26 | with: 27 | name: file 28 | path: ${{ env.FILE_PATH }} 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | #dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | v20.10.0 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Write File Action 2 | 3 | This action writes a file. 4 | 5 | ## Inputs 6 | 7 | ### `path` 8 | 9 | **Required** The path to the file to write. 10 | 11 | ### `contents` 12 | 13 | **Required** The contents of the file. 14 | 15 | ### `write-mode` 16 | 17 | **Optional** The mode of writing to use: `overwrite`, `append`, or `preserve`. 18 | 19 | Modes: 20 | 21 | - `overwrite` - overwrite the file if it exists 22 | - `append` - if the file exists, it will be appended to 23 | - `preserve` - if the file already exists the contents will not be written to 24 | 25 | **Default** `append` 26 | 27 | ## Outputs 28 | 29 | ### `size` 30 | 31 | Returns the file size. 32 | 33 | ## Example usage 34 | 35 | ```yaml 36 | uses: DamianReeves/write-file-action@master 37 | with: 38 | path: ${{ env.home}}/.bashrc 39 | contents: | 40 | Hello World! 41 | write-mode: append 42 | ``` 43 | 44 | ## Example usage with checkout, commit and push 45 | ```yaml 46 | name: Overwrite some file 47 | 48 | on: 49 | push: 50 | branches: [ main ] 51 | workflow_dispatch: 52 | 53 | jobs: 54 | build: 55 | runs-on: ubuntu-latest 56 | steps: 57 | - name: Checkout repo 58 | uses: actions/checkout@v3 59 | 60 | - name: Overwrite file 61 | uses: "DamianReeves/write-file-action@master" 62 | with: 63 | path: path/to/file.js 64 | write-mode: overwrite 65 | contents: | 66 | console.log('some contents') 67 | 68 | - name: Commit & Push 69 | uses: Andro999b/push@v1.3 70 | with: 71 | github_token: ${{ secrets.GITHUB_TOKEN }} 72 | branch: main 73 | force: true 74 | message: 'Overwritten by Github Actions - ${date}' 75 | ``` 76 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: "Write File" 2 | author: "Damian Reeves" 3 | description: "Write a file." 4 | inputs: 5 | path: # id of input 6 | description: "The path to the file to write" 7 | required: true 8 | 9 | contents: 10 | description: "The contents of the file" 11 | required: true 12 | 13 | write-mode: 14 | description: "The mode of writing to use: `overwrite`, `append`, `append-newline` or `preserve`." 15 | required: false 16 | default: preserve 17 | outputs: 18 | size: 19 | description: "The returned size" 20 | 21 | runs: 22 | using: "node20" 23 | main: "dist/index.js" 24 | branding: 25 | icon: "package" 26 | color: "gray-dark" 27 | -------------------------------------------------------------------------------- /ci/test-output/out.js: -------------------------------------------------------------------------------- 1 | console.log('some contents: master') -------------------------------------------------------------------------------- /dist/index.d.ts: -------------------------------------------------------------------------------- 1 | export {}; 2 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "write-file-action", 3 | "version": "1.0.0", 4 | "lockfileVersion": 3, 5 | "requires": true, 6 | "packages": { 7 | "": { 8 | "name": "write-file-action", 9 | "version": "1.0.0", 10 | "license": "Apache 2.0", 11 | "dependencies": { 12 | "@actions/core": "^1.10.0", 13 | "@actions/io": "^1.1.3" 14 | }, 15 | "devDependencies": { 16 | "@types/node": "^20.11.16", 17 | "@vercel/ncc": "^0.38.1", 18 | "typescript": "^5.3.3" 19 | } 20 | }, 21 | "node_modules/@actions/core": { 22 | "version": "1.10.1", 23 | "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz", 24 | "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==", 25 | "dependencies": { 26 | "@actions/http-client": "^2.0.1", 27 | "uuid": "^8.3.2" 28 | } 29 | }, 30 | "node_modules/@actions/http-client": { 31 | "version": "2.2.1", 32 | "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.2.1.tgz", 33 | "integrity": "sha512-KhC/cZsq7f8I4LfZSJKgCvEwfkE8o1538VoBeoGzokVLLnbFDEAdFD3UhoMklxo2un9NJVBdANOresx7vTHlHw==", 34 | "dependencies": { 35 | "tunnel": "^0.0.6", 36 | "undici": "^5.25.4" 37 | } 38 | }, 39 | "node_modules/@actions/io": { 40 | "version": "1.1.3", 41 | "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz", 42 | "integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q==" 43 | }, 44 | "node_modules/@fastify/busboy": { 45 | "version": "2.1.1", 46 | "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", 47 | "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", 48 | "engines": { 49 | "node": ">=14" 50 | } 51 | }, 52 | "node_modules/@types/node": { 53 | "version": "20.12.8", 54 | "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.8.tgz", 55 | "integrity": "sha512-NU0rJLJnshZWdE/097cdCBbyW1h4hEg0xpovcoAQYHl8dnEyp/NAOiE45pvc+Bd1Dt+2r94v2eGFpQJ4R7g+2w==", 56 | "dev": true, 57 | "dependencies": { 58 | "undici-types": "~5.26.4" 59 | } 60 | }, 61 | "node_modules/@vercel/ncc": { 62 | "version": "0.38.1", 63 | "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.1.tgz", 64 | "integrity": "sha512-IBBb+iI2NLu4VQn3Vwldyi2QwaXt5+hTyh58ggAMoCGE6DJmPvwL3KPBWcJl1m9LYPChBLE980Jw+CS4Wokqxw==", 65 | "dev": true, 66 | "bin": { 67 | "ncc": "dist/ncc/cli.js" 68 | } 69 | }, 70 | "node_modules/tunnel": { 71 | "version": "0.0.6", 72 | "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", 73 | "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==", 74 | "engines": { 75 | "node": ">=0.6.11 <=0.7.0 || >=0.7.3" 76 | } 77 | }, 78 | "node_modules/typescript": { 79 | "version": "5.4.5", 80 | "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", 81 | "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==", 82 | "dev": true, 83 | "bin": { 84 | "tsc": "bin/tsc", 85 | "tsserver": "bin/tsserver" 86 | }, 87 | "engines": { 88 | "node": ">=14.17" 89 | } 90 | }, 91 | "node_modules/undici": { 92 | "version": "5.28.4", 93 | "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", 94 | "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", 95 | "dependencies": { 96 | "@fastify/busboy": "^2.0.0" 97 | }, 98 | "engines": { 99 | "node": ">=14.0" 100 | } 101 | }, 102 | "node_modules/undici-types": { 103 | "version": "5.26.5", 104 | "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", 105 | "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", 106 | "dev": true 107 | }, 108 | "node_modules/uuid": { 109 | "version": "8.3.2", 110 | "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", 111 | "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", 112 | "bin": { 113 | "uuid": "dist/bin/uuid" 114 | } 115 | } 116 | } 117 | } 118 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "write-file-action", 3 | "version": "1.0.0", 4 | "description": "A GitHub action to write a file.", 5 | "main": "index.js", 6 | "scripts": { 7 | "build": "ncc build ./src/index.ts" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/DamianReeves/write-file-action.git" 12 | }, 13 | "keywords": [], 14 | "author": "", 15 | "license": "Apache 2.0", 16 | "bugs": { 17 | "url": "https://github.com/DamianReeves/write-file-action/issues" 18 | }, 19 | "homepage": "https://github.com/DamianReeves/write-file-action#readme", 20 | "dependencies": { 21 | "@actions/core": "^1.10.0", 22 | "@actions/io": "^1.1.3" 23 | }, 24 | "devDependencies": { 25 | "@types/node": "^20.11.16", 26 | "@vercel/ncc": "^0.38.1", 27 | "typescript": "^5.3.3" 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { getInput, setFailed, setOutput } from "@actions/core"; 2 | import { mkdirP } from "@actions/io"; 3 | import { appendFile, exists, writeFile, stat } from "fs"; 4 | import { readFile } from "fs/promises" 5 | import { dirname, join as joinPath, resolve as resolvePath } from "path"; 6 | import { promisify } from "util"; 7 | 8 | const appendFileAsync = promisify(appendFile); 9 | const existsAsync = promisify(exists); 10 | const writeFileAsync = promisify(writeFile); 11 | const statAsync = promisify(stat); 12 | 13 | main().catch((error) => setFailed(error.message)); 14 | 15 | async function main() { 16 | try { 17 | const path = getInput("path", { required: true }); 18 | let contents = getInput("contents", { required: true }); 19 | const mode = (getInput("write-mode") || "append").toLocaleLowerCase(); 20 | 21 | // Ensure the correct mode is specified 22 | if (mode !== "append" && mode !== "append-newline" && mode !== "overwrite" && mode !== "preserve") { 23 | setFailed("Mode must be one of: overwrite, append, or preserve"); 24 | return; 25 | } 26 | 27 | // Preserve the file 28 | if (mode === "preserve" && (await existsAsync(path))) { 29 | const statResult = await statAsync(path); 30 | setOutput("size", `${statResult.size}`); 31 | return; 32 | } 33 | 34 | const targetDir = dirname(path); 35 | 36 | await mkdirP(targetDir); 37 | 38 | if (mode === "overwrite") { 39 | await writeFileAsync(path, contents); 40 | } else if (mode == "append-newline"){ 41 | const fileData = (await readFile(path)).toString(); 42 | // only add a newline if one is necessary, don't introduce empty lines 43 | if (!endsInNewlines(fileData)){ 44 | // this code assumes lf is wanted because it's what i (Erisa) needed 45 | console.log("thought it didnt end in newline") 46 | contents = "\n" + contents; 47 | } 48 | // if the input **doesn't** end with a newline, add one of those as well 49 | if (!endsInNewlines(contents)){ 50 | console.log("thought input didnt end in newline") 51 | contents += "\n"; 52 | } 53 | 54 | await appendFileAsync(path, contents); 55 | } 56 | else { 57 | await appendFileAsync(path, contents); 58 | } 59 | 60 | const statResult = await statAsync(path); 61 | setOutput("size", `${statResult.size}`); 62 | } catch (error) { 63 | setFailed((error as Error).message); 64 | } 65 | } 66 | 67 | function endsInNewlines(text: string){ 68 | if (text.endsWith("\n") || text.endsWith("\r") || text.endsWith("\r\n")){ 69 | return true; 70 | } else { 71 | return false; 72 | } 73 | } -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "esModuleInterop": true, 4 | "module": "commonjs", 5 | "strict": true, 6 | "declaration": true, 7 | "target": "es6", 8 | "sourceMap": true, 9 | "lib": ["es6"], 10 | "baseUrl": "./", 11 | "outDir": "./lib", 12 | "rootDir": "./src" 13 | }, 14 | "exclude": ["node_modules", "**/*.test.ts"], 15 | "include": ["./src"] 16 | } 17 | --------------------------------------------------------------------------------