|
21 | 21 |
|
22 | 22 | ### Installation |
23 | 23 |
|
24 | | -- Install *globally*, making `repo-describer` available as a CLI on any path on your system: |
| 24 | +- Install _globally_, making `repo-describer` available as a CLI on any path on your system: |
25 | 25 |
|
26 | 26 | <!-- doc-gen INSTALL global=true --> |
27 | | - ```bash |
28 | | - npm install -g repo-description |
29 | | - ``` |
| 27 | + ```bash |
| 28 | + npm install -g repo-description |
| 29 | + ``` |
30 | 30 |
|
31 | | - ```bash |
32 | | - yarn add -g repo-description |
33 | | - ``` |
| 31 | + ```bash |
| 32 | + yarn add -g repo-description |
| 33 | + ``` |
34 | 34 | <!-- end-doc-gen --> |
35 | 35 |
|
36 | | -- Install *locally* in your repository, ready to use in your code. |
| 36 | +- Install _locally_ in your repository, ready to use in your code. |
37 | 37 |
|
38 | 38 | <!-- doc-gen INSTALL --> |
39 | | - ```bash |
40 | | - npm install repo-description |
41 | | - ``` |
| 39 | + ```bash |
| 40 | + npm install repo-description |
| 41 | + ``` |
42 | 42 |
|
43 | | - ```bash |
44 | | - yarn add repo-description |
45 | | - ``` |
| 43 | + ```bash |
| 44 | + yarn add repo-description |
| 45 | + ``` |
46 | 46 | <!-- end-doc-gen --> |
47 | 47 |
|
48 | 48 | ### Usage |
@@ -277,29 +277,28 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file |
277 | 277 | ``` |
278 | 278 | repo-description/ |
279 | 279 | ├── __tests__ |
280 | | -│ ├── .gitkeep (66 B) # preserve empty test directory structure in version control. |
281 | | -│ └── cli.test.js (807 B) # test CLI functionality to ensure correct behavior. |
| 280 | +│ └── .gitkeep (66 B) |
282 | 281 | ├── .qodo |
283 | 282 | │ ├── agents |
284 | 283 | │ └── workflows |
285 | 284 | ├── src |
286 | | -│ ├── cli.js (2.7 KB) # implement command-line interface logic for running the tool. |
287 | | -│ ├── describe.js (8.3 KB) # handle repository file analysis and description generation. |
288 | | -│ ├── index.js (308 B) # export main module entry point for external usage. |
289 | | -│ └── utils.js (0 B) # provide utility functions to support core operations. |
290 | | -├── _descriptions.json (1.5 KB) |
291 | | -├── .env (69 B) |
292 | | -├── .gitignore (2.1 KB) # define files and directories to be ignored by Git version control. |
293 | | -├── .prettierrc.json (563 B) # configure Prettier code formatting rules for consistent style. |
294 | | -├── babel.config.js (92 B) # set up Babel configuration for JavaScript transpilation. |
295 | | -├── CHANGELOG.md (2.6 KB) |
296 | | -├── CONTRIBUTING.md (2.9 KB) # outline contribution guidelines for developers working on the project. |
297 | | -├── eslint.config.js (1.1 KB) # configure ESLint rules for linting JavaScript and JSON files. |
298 | | -├── LICENSE (1.0 KB) # declare project licensing terms under the MIT License. |
299 | | -├── md.config.js (438 B) # configure markdown-magic settings for automated documentation updates. |
300 | | -├── package-lock.json (297.6 KB) # lock exact versions of installed npm dependencies. |
301 | | -├── package.json (3.1 KB) # define project metadata, dependencies, and npm scripts. |
302 | | -├── README.md (17.7 KB) # introduce the project, its purpose, features, and usage instructions. |
303 | | -└── RULES_OF_CONDUCT.md (4.9 KB) # establish community standards and expected behavior for contributors. |
| 285 | +│ ├── cli.js (2.7 KB) # Sets up the `repo-describer` CLI with Commander, parses arguments and options, and orchestrates repository description generation, output saving, and optional config updates. |
| 286 | +│ ├── describe.js (8.3 KB) # [Generate] AI‑powered descriptions of a Git repository’s files, persist those descriptions, and update markdown‑magic configuration accordingly. |
| 287 | +│ ├── index.js (308 B) # Export... the `describeRepo`, `saveOutput`, and `updateMarkdownMagicConfig` functions as the public API of the `repo-describer` library. |
| 288 | +│ └── utils.js (0 B) # I’m happy to help, but I need to see the actual contents of **src\utils.js** in order to craft an accurate one‑sentence “[action]…” description. Could you paste the file’s code (or at least the relevant portion) here? |
| 289 | +├── _descriptions.json (2.9 KB) # Map each repository file to a concise description of its purpose. |
| 290 | +├── .env (69 B) # Sets the GROQ_API_KEY environment variable for API authentication. |
| 291 | +├── .gitignore (2.1 KB) |
| 292 | +├── .prettierrc.json (563 B) # Configure Prettier to use single quotes, trailing commas (es5), an 80‑character line width, and enforce a specific ordering of fields in package.json via the prettier-plugin-packagejson. |
| 293 | +├── babel.config.js (92 B) # Configure Babel to use the `@babel/preset‑env` preset with the target set to the current Node version. |
| 294 | +├── CHANGELOG.md (2.5 KB) # [record] a chronological list of version releases with dates and the associated bug‑fix entries for each version. |
| 295 | +├── CONTRIBUTING.md (2.9 KB) # [Guide] contributors on reporting bugs, suggesting enhancements, and submitting code changes via pull requests. |
| 296 | +├── eslint.config.js (1.1 KB) # Configure ESLint with base and Prettier settings, and add specialized parsers and recommended rules for JavaScript, JSON/JSONC, and YAML files. |
| 297 | +├── LICENSE (1.0 KB) # Granting permission to use, copy, modify, merge, publish, distribute, sublicense, and sell the software under the terms of the MIT License. |
| 298 | +├── md.config.js (438 B) # Exports a configuration object that sets default badge styling and registers multiple markdown‑magic transform plugins for file trees, badges, installation, acknowledgements, and command scripts. |
| 299 | +├── package-lock.json (289.8 KB) # [Locks] exact versions of the project’s direct and transitive npm dependencies to ensure reproducible, deterministic installations. |
| 300 | +├── package.json (3.0 KB) # Specify the package metadata, entry points, scripts, and distribution settings for the AI‑powered “repo‑describer” CLI tool. |
| 301 | +├── README.md (17.7 KB) # Introduces the AI‑powered CLI tool `repo‑description`, its purpose and usage overview, and displays project status badges. |
| 302 | +└── RULES_OF_CONDUCT.md (4.9 KB) # [Establish] a comprehensive, harassment‑free code of conduct that pledges inclusive, respectful behavior and outlines acceptable and unacceptable actions for contributors. |
304 | 303 | ``` |
305 | 304 | <!-- end-doc-gen --> |
0 commit comments