github-action-readme-generator 1.10.10 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/mjs/constants.d.ts +3 -3
  3. package/dist/mjs/helpers.js.map +1 -1
  4. package/dist/mjs/inputs.js.map +1 -1
  5. package/dist/mjs/logtask/index.js.map +1 -1
  6. package/dist/mjs/prettier.js.map +1 -1
  7. package/dist/mjs/readme-editor.js.map +1 -1
  8. package/dist/mjs/readme-generator.js.map +1 -1
  9. package/dist/mjs/sections/index.js.map +1 -1
  10. package/dist/mjs/sections/update-branding.js.map +1 -1
  11. package/dist/mjs/svg-editor.mjs.map +1 -1
  12. package/dist/types/Action.d.ts +154 -0
  13. package/dist/types/config.d.ts +47 -0
  14. package/dist/types/constants.d.ts +105 -0
  15. package/dist/types/errors/error-type.d.ts +7 -0
  16. package/dist/types/errors/is-error.d.ts +8 -0
  17. package/dist/types/helpers.d.ts +93 -0
  18. package/dist/types/index.d.ts +4 -1106
  19. package/dist/types/inputs.d.ts +153 -0
  20. package/dist/types/logtask/index.d.ts +95 -0
  21. package/dist/types/markdowner/index.d.ts +61 -0
  22. package/dist/types/prettier.d.ts +31 -0
  23. package/dist/types/readme-editor.d.ts +50 -0
  24. package/dist/types/readme-generator.d.ts +57 -0
  25. package/dist/types/save.d.ts +13 -0
  26. package/dist/types/sections/index.d.ts +11 -0
  27. package/dist/types/sections/update-badges.d.ts +16 -0
  28. package/dist/types/sections/update-branding.d.ts +55 -0
  29. package/dist/types/sections/update-contents.d.ts +9 -0
  30. package/dist/types/sections/update-description.d.ts +10 -0
  31. package/dist/types/sections/update-inputs.d.ts +10 -0
  32. package/dist/types/sections/update-outputs.d.ts +11 -0
  33. package/dist/types/sections/update-title.d.ts +10 -0
  34. package/dist/types/sections/update-usage.d.ts +3 -0
  35. package/dist/types/svg-editor.d.mts +47 -0
  36. package/dist/types/unicode-word-match.d.ts +1 -0
  37. package/dist/types/util.d.ts +2 -0
  38. package/dist/types/working-directory.d.ts +6 -0
  39. package/package.json +3 -4
package/dist/types/working-directory.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Returns the working directory path based on the environment variables.
3
+ * The order of preference is GITHUB_WORKSPACE, INIT_CWD, and then the current working directory.
4
+ * @returns The working directory path.
5
+ */
6
+ export default function workingDirectory(): string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "github-action-readme-generator",
3
3
  "displayName": "bitflight-devops/github-action-readme-generator",
4
- "version": "1.10.10",
4
+ "version": "1.11.0",
5
5
  "description": "The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.",
6
6
  "keywords": [
7
7
  "github-actions",
@@ -50,7 +50,7 @@
50
50
  "all": "npm run build && npm run format && npm run lint && npm run test",
51
51
  "prebuild": "tsc --project tsconfig.json --noemit",
52
52
  "build": "rimraf dist out;node ./scripts/esbuild.mjs && chmod +x dist/bin/index.js",
53
- "postbuild": "tsc --project tsconfig.json --emitDeclarationOnly --declaration --outFile dist/types/index.d.ts && tsc -p tsconfig-mjs.json && ./scripts/set_package_type.sh",
53
+ "postbuild": "tsc --project tsconfig.build.json --emitDeclarationOnly --declaration --outDir dist/types && tsc -p tsconfig-mjs.json && ./scripts/set_package_type.sh",
54
54
  "build:docker": "run-script-os",
55
55
  "build:docker:default": "docker run --rm -t -v $(pwd):/work -w /work node:24-alpine sh -c 'npm run build'",
56
56
  "build:docker:win32": "docker run --rm -t -v \"%cd%\":/work -w /work node:24-alpine sh -c \"npm run build\"",
@@ -182,9 +182,8 @@
182
182
  "rimraf": "^6.1.2",
183
183
  "run-script-os": "^1.1.6",
184
184
  "semantic-release": "^25.0.2",
185
- "ts-node": "^10.9.1",
186
185
  "types-package-json": "^2.0.39",
187
- "typescript": "^6.0.3",
186
+ "typescript": "7.0.2",
188
187
  "vitest": "^4.1.2"
189
188
  },
190
189
  "engines": {