nick2bad4u/Generate Repo File List
Generates an HTML file list for a GitHub repository with links to each file.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| log-level | Set the logging level setting manually instead of pulling from environment | no | INFO |
| directory | Root directory of the repository to generate the file list for. Default is the current directory. | no | . |
| repo-url | GitHub repository URL to use for generating file links. Default is determined by the Git configuration. | no | https://github.com/Nick2bad4u/UserStyles |
| fallback-repo-url | Fallback GitHub repository URL to use if the default URL cannot be determined. | no | https://github.com/author/repo |
| output-format | File Format to be output in, if using for readme.md via github use MD, for readme.md on web use html". | no | html |
| output-file | Name of the output HTML file to save the generated file list. Default is "file_list.md". | no | file_list.md |
| color-source | Source of colors for the file links. Choose "random" for randomly generated colors or "list" to use a predefined list of colors. | no | random |
| color-list | List of colors to use when the color source is set to "list". Provide colors in hex format (e.g., #FF0000). | no | #FF0000 #00FF00 #0000FF #FFFF00 #FF00FF #00FFFF |
| color-range-start | Start of the range of colors (hex code) for random color generation (e.g., #000000). | no | #000000 |
| color-range-end | End of the range of colors (hex code) for random color generation (e.g., #FFFFFF). | no | #FFFFFF |
| max-attempts | Maximum number of attempts to generate a valid color. Default is 1000000. | no | 1000000 |
| exclude-blacks-threshold | Threshold for excluding black colors. Any color below this threshold on the color chart will be excluded (e.g., #222222). | no | #222222 |
| exclude-dark-colors | Exclude dark colors from being used for file links. Use this option to avoid dark colors. | no | false |
| exclude-bright-colors | Exclude bright colors from being used for file links. Use this option to avoid bright colors. | no | false |
| exclude-blacks | Exclude black colors below a certain threshold from being used for file links. Use this option to avoid very dark colors. | no | false |
| ensure-readable-colors | Ensure that the generated colors are readable by maintaining a certain contrast ratio with a white background. | no | false |
| repo-root-header | Header text for files located in the root of the repository. Default is "Repo Root". | no | Repo Root |
| header-text | Header text for the file list displayed at the top of the generated HTML file. Default is "## File List". | no | ## File List |
| intro-text | Introductory text for the file list displayed below the header in the generated HTML file. Default is "# Here is a list of files included in this repository:". | no | # Here is a list of files included in this repository: |
| file-categories | Space-separated pairs of file extensions and display names (e.g., ".py Python .js JavaScript"). | no | "" |
| overwrite-file-categories | Set to "true" to replace the default categories instead of extending them. | no | false |
| ignore-list | Space-separated list of additional paths to ignore during traversal. | no | "" |
| overwrite-ignore-list | Set to "true" to replace the default ignore list. | no | false |
| dark-color-luminance-threshold | Luminance threshold for determining if a color is dark. Colors with luminance below this value will be considered dark. Default is 128. | no | 128 |
| bright-color-luminance-threshold | Luminance threshold for determining if a color is bright. Colors with luminance above this value will be considered bright. Default is 200. | no | 200 |
| chunk-size | Number of lines per chunk for lazy loading the file list. Default is 40 lines per chunk. | no | 40 |
| viewport-mobile | Viewport size for mobile devices in pixels. Default is 768. | no | 768 |
| viewport-tablet | Viewport size for tablets in pixels. Default is 1024. | no | 1024 |
| viewport-small-desktop | Viewport size for small desktops in pixels. Default is 1440. | no | 1440 |
| root-margin-large-desktop | Root margin for the IntersectionObserver for large desktop viewport. Default is "0px 0px 400px 0px". | no | 0px 0px 400px 0px |
| root-margin-small-desktop | Root margin for the IntersectionObserver for small desktops. Default is "0px 0px 300px 0px". | no | 0px 0px 300px 0px |
| root-margin-tablet | Root margin for the IntersectionObserver for tablets. Default is "0px 0px 200px 0px". | no | 0px 0px 200px 0px |
| root-margin-mobile | Root margin for the IntersectionObserver for mobile devices. Default is "0px 0px 100px 0px". | no | 0px 0px 100px 0px |
| respect-gitignore | Set to "true" to honour .gitignore by using git ls-files when available. | no | false |
| default-branch | Fallback branch name to use when link-ref is not provided. | no | "" |
| link-ref | Explicit branch, tag, or commit to use when generating links. | no | "" |
| gtm-id | Google Tag Manager container ID to embed in generated HTML (for example GTM-T8J6HPLF). | no | GTM-T8J6HPLF |
| output-file-stdout | Set to "true" to send the generated content to stdout instead of writing to a file. | no | false |
Outputs
no outputs