shadowdocs 2.1.6 → 2.1.7

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.
package/CONTRIBUTING.md CHANGED
@@ -1,83 +1,51 @@
1
1
  # Contributing to ShadowDocs
2
+ ==========================
2
3
 
3
- Thank you for your interest in contributing to ShadowDocs!
4
-
5
- ## Code of Conduct
6
-
7
- This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
8
-
9
- - Be respectful and inclusive
10
- - No harassment or discrimination
11
- - No offensive language or behavior
12
- - Violations will result in immediate account suspension
13
-
14
- ## How to Contribute
15
-
16
- ### Reporting Bugs
17
-
18
- 1. Check existing issues first
19
- 2. Create a detailed bug report with:
20
- - Clear title and description
21
- - Steps to reproduce
22
- - Expected vs actual behavior
23
- - Environment details (OS, Node version, etc.)
24
-
25
- ### Suggesting Features
26
-
27
- 1. Search existing feature requests
28
- 2. Provide clear use case
29
- 3. Explain why this feature would be useful
30
- 4. Be open to discussion
31
-
32
- ### Pull Requests
33
-
34
- 1. Fork the repository
35
- 2. Create a feature branch: `git checkout -b feature/amazing-feature`
36
- 3. Make your changes
37
- 4. Add tests if applicable
38
- 5. Ensure code style is consistent
39
- 6. Commit with clear messages: `git commit -m 'Add amazing feature'`
40
- 7. Push to your fork: `git push origin feature/amazing-feature`
41
- 8. Open a Pull Request
4
+ Thank you for considering contributing to ShadowDocs, an AI-powered documentation generator for developer projects. This guide outlines the process for contributing to the project, including development setup, testing requirements, and guidelines for submitting changes.
42
5
 
43
6
  ## Development Setup
7
+ --------------------
44
8
 
45
- ```bash
46
- git clone https://github.com/shadowofficial206/shadowdocs.git
47
- cd shadowdocs
48
- npm install
49
- ```
9
+ To start contributing to ShadowDocs, follow these steps:
50
10
 
51
- ### Running Locally
11
+ 1. **Clone the repository**: Clone the ShadowDocs repository using Git: `git clone https://github.com/[repository-url].git`
12
+ 2. **Install dependencies**: Install the required dependencies by running `npm install` or `yarn install` in the project root directory.
13
+ 3. **Build the project**: Run `npm run build` or `yarn build` to build the project.
14
+ 4. **Start the development server**: Run `npm run dev` or `yarn dev` to start the development server in watch mode.
52
15
 
53
- ```bash
54
- npm install -g .
55
- shadowdocs
56
- ```
16
+ ## Testing Requirements
17
+ ----------------------
57
18
 
58
- ### Testing
19
+ Before submitting changes, ensure that the following testing requirements are met:
59
20
 
60
- ```bash
61
- npm test
62
- ```
21
+ 1. **Type checking**: Run `npm run typecheck` or `yarn typecheck` to verify that the code is type-safe.
22
+ 2. **Unit tests**: Run `npm test` or `yarn test` to execute the unit tests.
23
+ 3. **Integration tests**: Run `npm run test:integration` or `yarn test:integration` to execute the integration tests.
63
24
 
64
- ## Style Guide
25
+ ## Guidelines for Contributing
26
+ -----------------------------
65
27
 
66
- - Use ESM modules (`import`/`export`)
67
- - Use async/await over promises
68
- - Keep functions small and focused
69
- - Add comments for complex logic
70
- - Use meaningful variable names
28
+ 1. **Code style**: Follow the existing code style and formatting conventions.
29
+ 2. **Commit messages**: Use descriptive and concise commit messages that follow the standard GitHub guidelines.
30
+ 3. **Pull requests**: Submit changes as pull requests, including a clear description of the changes and any relevant testing or verification.
31
+ 4. **Code reviews**: Participate in code reviews to ensure that changes meet the project's standards and requirements.
71
32
 
72
- ## Questions?
33
+ ## Submitting Changes
34
+ --------------------
73
35
 
74
- - Open an issue for questions
75
- - Don't open issues for general questions
36
+ To submit changes to ShadowDocs, follow these steps:
76
37
 
77
- ## Recognition
38
+ 1. **Create a new branch**: Create a new branch from the main branch using `git checkout -b [branch-name]`.
39
+ 2. **Make changes**: Make the desired changes to the codebase.
40
+ 3. **Commit changes**: Commit the changes using `git commit -m "[commit-message]"`.
41
+ 4. **Push changes**: Push the changes to the remote repository using `git push origin [branch-name]`.
42
+ 5. **Create a pull request**: Create a pull request from the new branch to the main branch, including a clear description of the changes.
78
43
 
79
- Contributors will be recognized in the README and on GitHub.
44
+ ## Additional Resources
45
+ -----------------------
80
46
 
81
- ---
47
+ * **Project structure**: Familiarize yourself with the project structure, including the `src`, `bin`, and `ui` directories.
48
+ * **Dependencies**: Review the project dependencies and dev dependencies listed in `package.json`.
49
+ * **Security**: Review the security guidelines and best practices outlined in `SECURITY.md`.
82
50
 
83
- **By contributing, you agree to abide by our terms and the MIT License.**
51
+ By following these guidelines and requirements, you can help ensure that your contributions to ShadowDocs are high-quality, effective, and align with the project's goals and standards. Thank you for your contributions!
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2024 ShadowDocs
3
+ Copyright (c) 2024 shadowdocs
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,109 +1,141 @@
1
1
  # ShadowDocs
2
- ## Overview
3
- ShadowDocs is an AI-powered documentation generator designed to assist developers in creating high-quality project documentation. Its primary purpose is to streamline the documentation process, making it easier for developers to focus on their core work. By leveraging AI capabilities, ShadowDocs aims to reduce the time and effort required to generate and maintain project documentation.
4
-
5
- ## Version
6
- Current version: 2.1.5
7
-
8
- ## Description
9
- ShadowDocs is a module designed for developer projects, providing an efficient way to generate documentation using AI. It is particularly useful for projects that require extensive documentation, as it can significantly reduce the workload associated with creating and updating documentation. With ShadowDocs, developers can ensure that their projects have accurate, up-to-date, and comprehensive documentation, which is essential for collaboration, maintenance, and user adoption.
10
-
11
- ## Features
12
- - AI-powered documentation generation
13
- - Real-time documentation updates with `--watch` mode
14
- - Command-line interface (CLI) for easy usage
15
- - Type checking for ensuring code quality
16
- - Interactive mode for customized documentation generation
17
-
2
+ ================
3
+ AI-powered documentation generator for developer projects.
4
+
5
+ ## Table of Contents
6
+ -----------------
7
+
8
+ 1. [Introduction](#introduction)
9
+ 2. [Getting Started](#getting-started)
10
+ 3. [Project Structure](#project-structure)
11
+ 4. [Installation](#installation)
12
+ 5. [Usage](#usage)
13
+ 6. [API Documentation](#api-documentation)
14
+ 7. [Contributing](#contributing)
15
+ 8. [Security](#security)
16
+ 9. [License](#license)
17
+
18
+ ## Introduction
19
+ ------------
20
+
21
+ ShadowDocs is a module designed to generate high-quality documentation for developer projects using AI-powered technology. With ShadowDocs, you can easily create and maintain accurate and up-to-date documentation for your projects.
22
+
23
+ ## Getting Started
24
+ ---------------
25
+
26
+ To get started with ShadowDocs, follow these steps:
27
+
28
+ 1. Install the required dependencies using npm or yarn.
29
+ 2. Run the `build` script to compile the TypeScript code.
30
+ 3. Run the `start` script to start the ShadowDocs CLI.
31
+
32
+ ## Project Structure
33
+ ------------------
34
+
35
+ The ShadowDocs project is structured as follows:
36
+ ```markdown
37
+ shadowdocs/
38
+ ├── bin/
39
+ ├── cli.js
40
+ ├── src/
41
+ ├── core/
42
+ ├── config.ts
43
+ ├── events.ts
44
+ ├── index.ts
45
+ ├── types.ts
46
+ ├── ui.ts
47
+ ├── services/
48
+ ├── ai.ts
49
+ ├── analyzer.ts
50
+ ├── index.ts
51
+ ├── scanner.ts
52
+ ├── ui/
53
+ ├── components/
54
+ ├── contexts/
55
+ ├── hooks/
56
+ ├── App.tsx
57
+ ├── cli-ink.ts
58
+ ├── ink.tsx
59
+ ├── interactive.ts
60
+ ├── CONTRIBUTING.md
61
+ ├── LICENSE
62
+ ├── package-lock.json
63
+ ├── package.json
64
+ ├── README.md
65
+ ├── SECURITY.md
66
+ ├── shadowdocs-2.0.1.tgz
67
+ ├── tsconfig.json
68
+ ```
18
69
  ## Installation
70
+ ------------
71
+
19
72
  To install ShadowDocs, run the following command:
20
73
  ```bash
21
74
  npm install shadowdocs
22
75
  ```
23
-
24
- ## Usage
25
- ShadowDocs can be used in various ways, depending on the specific requirements of your project. Here are a few examples:
76
+ or
26
77
  ```bash
27
- # Build documentation
28
- npx shadowdocs build
29
-
30
- # Start documentation generation in watch mode
31
- npx shadowdocs dev
32
-
33
- # Start the CLI
34
- npx shadowdocs start
78
+ yarn add shadowdocs
35
79
  ```
36
- In your JavaScript or TypeScript files, you can also use ShadowDocs as a module:
37
- ```javascript
38
- const { generateDocumentation } = require('shadowdocs');
80
+ ## Usage
81
+ -----
39
82
 
40
- // Generate documentation
41
- generateDocumentation('path/to/project');
83
+ To use ShadowDocs, run the following command:
84
+ ```bash
85
+ npx shadowdocs
42
86
  ```
87
+ This will start the ShadowDocs CLI. You can then follow the prompts to generate documentation for your project.
43
88
 
44
- ## API Reference
45
- ShadowDocs exports several functions and classes that can be used to customize and extend its functionality. Some of the key exports include:
46
- - `generateDocumentation`: Generates documentation for a given project
47
- - `configure`: Configures ShadowDocs with custom settings
48
- - `Analyzer`: A class for analyzing project code and generating documentation
89
+ ### Example Usage
49
90
 
50
- ## Configuration
51
- ShadowDocs provides several configuration options that can be used to customize its behavior. These options can be specified in a `config.ts` file or passed as command-line arguments. Some of the available options include:
52
- - `outputPath`: Specifies the output path for generated documentation
53
- - `template`: Specifies a custom template for generated documentation
54
- - `watch`: Enables or disables watch mode
55
-
56
- ## Development
57
- To set up a development environment for ShadowDocs, follow these steps:
91
+ Here is an example of how to use ShadowDocs to generate documentation for a sample project:
58
92
  ```bash
59
- # Install dependencies
60
- npm install
93
+ # Create a new project
94
+ mkdir myproject
95
+ cd myproject
61
96
 
62
- # Build and watch the code
63
- npm run dev
64
- ```
65
- This will start the development server, and you can begin making changes to the codebase.
97
+ # Initialize a new npm project
98
+ npm init -y
66
99
 
67
- ## Testing
68
- To run tests for ShadowDocs, use the following command:
69
- ```bash
70
- # Run type checking
71
- npm run typecheck
100
+ # Install ShadowDocs
101
+ npm install shadowdocs
102
+
103
+ # Run ShadowDocs
104
+ npx shadowdocs
72
105
  ```
73
- Note that ShadowDocs currently uses TypeScript for type checking, and there are no additional tests beyond type checking.
106
+ This will generate documentation for the `myproject` project.
74
107
 
75
- ## License
76
- MIT License
108
+ ## API Documentation
109
+ ------------------
77
110
 
78
- Copyright (c) 2023 ShadowDocs
111
+ The ShadowDocs API is documented below:
79
112
 
80
- Permission is hereby granted, free of charge, to any person obtaining a copy
81
- of this software and associated documentation files (the "Software"), to deal
82
- in the Software without restriction, including without limitation the rights
83
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
84
- copies of the Software, and to permit persons to whom the Software is
85
- furnished to do so, subject to the following conditions:
113
+ ### Core
86
114
 
87
- The above copyright notice and this permission notice shall be included in all
88
- copies or substantial portions of the Software.
115
+ * `config.ts`: Configuration module for ShadowDocs.
116
+ * `events.ts`: Event handling module for ShadowDocs.
117
+ * `index.ts`: Main entry point for ShadowDocs.
118
+ * `types.ts`: Type definitions for ShadowDocs.
119
+ * `ui.ts`: UI component module for ShadowDocs.
89
120
 
90
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
91
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
92
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
93
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
94
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
95
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
96
- SOFTWARE.
121
+ ### Services
122
+
123
+ * `ai.ts`: AI-powered documentation generation module.
124
+ * `analyzer.ts`: Code analysis module for ShadowDocs.
125
+ * `index.ts`: Main entry point for services module.
126
+ * `scanner.ts`: Code scanner module for ShadowDocs.
97
127
 
98
128
  ## Contributing
99
- Contribution Guidelines:
100
- - Fork the ShadowDocs repository and create a new feature branch
101
- - Follow the existing code style and conventions
102
- - Add tests if applicable to ensure the quality of the code
103
- - Submit a pull request with a detailed description of the changes
129
+ ------------
130
+
131
+ To contribute to ShadowDocs, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
132
+
133
+ ## Security
134
+ ---------
104
135
 
105
- ## Security Policy
106
- If you discover a vulnerability in ShadowDocs, please report it to the maintainers via email or by submitting an issue on the GitHub repository. We take security seriously and will address vulnerabilities promptly.
136
+ To report a security vulnerability, please see the [SECURITY.md](SECURITY.md) file.
137
+
138
+ ## License
139
+ -------
107
140
 
108
- ## Code of Conduct
109
- We are committed to creating a welcoming and inclusive environment for all contributors. We expect all participants to be respectful, considerate, and professional. Harassment, discrimination, or other forms of unacceptable behavior will not be tolerated and may result in immediate suspension or removal from the project.
141
+ ShadowDocs is licensed under the [MIT License](LICENSE).
package/SECURITY.md CHANGED
@@ -1,52 +1,35 @@
1
- # Security Policy
1
+ # SECURITY.md
2
+ ## Introduction
3
+ The shadowdocs project takes the security of its users seriously. We are committed to ensuring the integrity and confidentiality of the data used with our AI-powered documentation generator.
2
4
 
3
- ## Supported Versions
5
+ ## Reporting Security Vulnerabilities
6
+ If you believe you have found a security vulnerability in shadowdocs, please report it to us immediately. We appreciate your help in making shadowdocs more secure.
4
7
 
5
- | Version | Supported |
6
- | ------- | ------------------- |
7
- | 1.2.x | ✓ :white_check_mark: |
8
- | 1.1.x | ✓ :white_check_mark: |
9
- | < 1.1 | ✗ |
8
+ To report a security vulnerability, please follow these steps:
10
9
 
11
- ## Reporting a Vulnerability
10
+ 1. **Do not** open an issue on the GitHub issue tracker. Instead, send an email to [security@shadowdocs.io](mailto:security@shadowdocs.io) with the subject "Security Vulnerability Report".
11
+ 2. Provide a detailed description of the vulnerability, including:
12
+ * A clear explanation of the issue
13
+ * Steps to reproduce the issue (if applicable)
14
+ * Any relevant code snippets or logs
15
+ 3. We will respond to your email within **3 business days** to acknowledge receipt of your report and provide a timeline for addressing the issue.
12
16
 
13
- If you discover a security vulnerability within ShadowDocs, please send an email to security@shadowdocs.app.
17
+ ## Security Information
18
+ The shadowdocs project uses the following security measures:
14
19
 
15
- All security vulnerabilities will be promptly addressed.
16
-
17
- ## What to Include
18
-
19
- - Description of the vulnerability
20
- - Steps to reproduce
21
- - Potential impact
22
- - Any suggested fixes (optional)
23
-
24
- ## Scope
25
-
26
- - API key exposure vulnerabilities
27
- - Code injection risks
28
- - Data privacy issues
29
- - Authentication/authorization bypasses
30
-
31
- ## Out of Scope
32
-
33
- - Social engineering attacks
34
- - Physical security
35
- - Denial of service (unless severe)
36
- - Issues in third-party dependencies (report to maintainers)
20
+ * **Dependencies**: We regularly review and update our dependencies to ensure we are using the latest secure versions.
21
+ * **Code Reviews**: All code changes are reviewed by at least one other developer before being merged into the main branch.
22
+ * **Testing**: We have a comprehensive test suite to ensure our code is working as expected.
37
23
 
38
24
  ## Response Timeline
25
+ We strive to address security vulnerabilities in a timely and responsible manner. Our response timeline is as follows:
39
26
 
40
- - Acknowledge: 24-48 hours
41
- - Initial assessment: 3-5 days
42
- - Fix released: Based on severity
43
-
44
- ## Security Updates
45
-
46
- Security updates will be released as patch versions and announced on:
47
- - GitHub Security Advisories
48
- - npm security alerts
27
+ * **Acknowledgement**: We will respond to your initial report within **3 business days** to acknowledge receipt of your report.
28
+ * **Initial Fix**: We will provide an initial fix for the vulnerability within **7 business days** of acknowledging the report.
29
+ * **Final Fix**: We will provide a final fix for the vulnerability, including any necessary updates to our dependencies, within **14 business days** of acknowledging the report.
49
30
 
50
- ---
31
+ ## Contact Information
32
+ For any security-related questions or concerns, please contact us at [security@shadowdocs.io](mailto:security@shadowdocs.io).
51
33
 
52
- **Do not open public issues for security vulnerabilities.**
34
+ ## Versioning
35
+ This SECURITY.md document applies to all versions of shadowdocs, including the current version (2.1.6). We will update this document as necessary to reflect changes to our security policies and procedures.
@@ -1 +1 @@
1
- {"version":3,"file":"Menu.d.ts","sourceRoot":"","sources":["../../../src/ui/components/Menu.tsx"],"names":[],"mappings":"AASA,UAAU,SAAS;IAClB,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAChC;AAWD,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,SAAS,2CA0DnD"}
1
+ {"version":3,"file":"Menu.d.ts","sourceRoot":"","sources":["../../../src/ui/components/Menu.tsx"],"names":[],"mappings":"AASA,UAAU,SAAS;IAClB,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAChC;AAWD,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,SAAS,2CAqDnD"}
@@ -28,6 +28,6 @@ export default function Menu({ onSelect }) {
28
28
  }
29
29
  }
30
30
  });
31
- return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Text, { bold: true, color: "cyan", children: "\u2588\u2588\u2557 \u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2557 \u2588\u2588\u2551 \u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2551 \u2588\u2588\u2551 \u2588\u2557 \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255D\u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2554\u2588\u2588\u2588\u2588\u2554\u2588\u2588\u2551 \u2588\u2588\u2551\u2588\u2588\u2588\u2557\u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u255D \u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557\u2588\u2588\u2554\u2550\u2550\u255D \u2588\u2588\u2554\u2550\u2550\u255D \u2588\u2588\u2551\u255A\u2588\u2588\u2554\u255D\u2588\u2588\u2551 \u255A\u2588\u2588\u2588\u2554\u2588\u2588\u2588\u2554\u255D\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2551 \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2551 \u255A\u2550\u255D \u2588\u2588\u2551 \u255A\u2550\u2550\u255D\u255A\u2550\u2550\u255D \u255A\u2550\u2550\u2550\u2550\u2550\u2550\u255D\u255A\u2550\u255D \u255A\u2550\u255D\u255A\u2550\u2550\u2550\u2550\u2550\u2550\u255D\u255A\u2550\u2550\u2550\u2550\u2550\u2550\u255D\u255A\u2550\u255D \u255A\u2550\u255D" }), _jsx(Text, { dimColor: true, children: "AI-Powered Documentation Generator" }), _jsx(Text, { children: "\n" }), _jsx(Text, { bold: true, children: "Commands" }), _jsx(Text, { dimColor: true, children: "\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500" }), menuItems.map((item, index) => (_jsx(Box, { flexDirection: "column", children: index === selectedIndex ? (_jsxs(_Fragment, { children: [_jsxs(Text, { bold: true, color: "red", children: [' ', "\u25B6 [", item.key, "] ", item.label] }), _jsxs(Text, { dimColor: true, children: [" ", item.desc] })] })) : (_jsxs(Text, { children: [" [", item.key, "] ", item.label] })) }, item.key))), _jsx(Text, { children: "\n" }), _jsx(Text, { dimColor: true, children: "Use w/s or arrow keys to navigate, Enter or key to select, q to quit" }), _jsx(Text, { dimColor: true, children: "Version 2.1.6" })] }));
31
+ return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Text, { bold: true, color: "cyan", children: ".-. . . .-. .-. .-. . . . .-. .-. .-. .-. `-. |-| |-| | ) | | | | | | ) | | | `-. `-' ' ` ` ' `-' `-' `.'.' `-' `-' `-' `-'" }), _jsx(Text, { dimColor: true, children: "AI-Powered Documentation Generator" }), _jsx(Text, { children: "\n" }), _jsx(Text, { bold: true, children: "Commands" }), _jsx(Text, { dimColor: true, children: "\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500" }), menuItems.map((item, index) => (_jsx(Box, { flexDirection: "column", children: index === selectedIndex ? (_jsxs(_Fragment, { children: [_jsxs(Text, { bold: true, color: "red", children: [' ', "\u25B6 [", item.key, "] ", item.label] }), _jsxs(Text, { dimColor: true, children: [" ", item.desc] })] })) : (_jsxs(Text, { children: [" [", item.key, "] ", item.label] })) }, item.key))), _jsx(Text, { children: "\n" }), _jsx(Text, { dimColor: true, children: "Use w/s or arrow keys to navigate, Enter or key to select, q to quit" }), _jsx(Text, { dimColor: true, children: "Version 2.1.6" })] }));
32
32
  }
33
33
  //# sourceMappingURL=Menu.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Menu.js","sourceRoot":"","sources":["../../../src/ui/components/Menu.tsx"],"names":[],"mappings":";AAAA,OAAc,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAY1C,MAAM,SAAS,GAAe;IAC7B,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,gDAAgD,EAAE;IAC5F,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,gCAAgC,EAAE;IAC3E,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IACpE,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE;IAC1D,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE;IAChD,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE;CACrD,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAa;IACnD,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEtD,QAAQ,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACvB,IAAI,KAAK,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAClC,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,KAAK,KAAK,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAC3C,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC7C,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACP,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YAClE,IAAI,IAAI,EAAE,CAAC;gBACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,CACN,MAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,EAAC,OAAO,EAAE,CAAC,aACrC,KAAC,IAAI,IAAC,IAAI,QAAC,KAAK,EAAC,MAAM,isDAShB,EAEP,KAAC,IAAI,IAAC,QAAQ,yDAA0C,EACxD,KAAC,IAAI,cAAE,IAAI,GAAQ,EAEnB,KAAC,IAAI,IAAC,IAAI,+BAAgB,EAC1B,KAAC,IAAI,IAAC,QAAQ,6EAAiB,EAE9B,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAC/B,KAAC,GAAG,IAAgB,aAAa,EAAC,QAAQ,YACxC,KAAK,KAAK,aAAa,CAAC,CAAC,CAAC,CAC1B,8BACC,MAAC,IAAI,IAAC,IAAI,QAAC,KAAK,EAAC,KAAK,aACpB,GAAG,cACA,IAAI,CAAC,GAAG,QAAI,IAAI,CAAC,KAAK,IACpB,EACP,MAAC,IAAI,IAAC,QAAQ,yBAAI,IAAI,CAAC,IAAI,IAAQ,IACjC,CACH,CAAC,CAAC,CAAC,CACH,MAAC,IAAI,sBAAK,IAAI,CAAC,GAAG,QAAI,IAAI,CAAC,KAAK,IAAQ,CACxC,IAXQ,IAAI,CAAC,GAAG,CAYZ,CACN,CAAC,EAEF,KAAC,IAAI,cAAE,IAAI,GAAQ,EACnB,KAAC,IAAI,IAAC,QAAQ,2FAA4E,EAC1F,KAAC,IAAI,IAAC,QAAQ,oCAAqB,IAC9B,CACN,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"Menu.js","sourceRoot":"","sources":["../../../src/ui/components/Menu.tsx"],"names":[],"mappings":";AAAA,OAAc,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAY1C,MAAM,SAAS,GAAe;IAC7B,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,gDAAgD,EAAE;IAC5F,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,gCAAgC,EAAE;IAC3E,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IACpE,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE;IAC1D,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE;IAChD,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE;CACrD,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAa;IACnD,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEtD,QAAQ,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACvB,IAAI,KAAK,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAClC,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,KAAK,KAAK,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAC3C,gBAAgB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC7C,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACP,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YAClE,IAAI,IAAI,EAAE,CAAC;gBACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,CACN,MAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,EAAC,OAAO,EAAE,CAAC,aACrC,KAAC,IAAI,IAAC,IAAI,QAAC,KAAK,EAAC,MAAM,8LAIhB,EAEP,KAAC,IAAI,IAAC,QAAQ,yDAA0C,EACxD,KAAC,IAAI,cAAE,IAAI,GAAQ,EAEnB,KAAC,IAAI,IAAC,IAAI,+BAAgB,EAC1B,KAAC,IAAI,IAAC,QAAQ,6EAAiB,EAE9B,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAC/B,KAAC,GAAG,IAAgB,aAAa,EAAC,QAAQ,YACxC,KAAK,KAAK,aAAa,CAAC,CAAC,CAAC,CAC1B,8BACC,MAAC,IAAI,IAAC,IAAI,QAAC,KAAK,EAAC,KAAK,aACpB,GAAG,cACA,IAAI,CAAC,GAAG,QAAI,IAAI,CAAC,KAAK,IACpB,EACP,MAAC,IAAI,IAAC,QAAQ,yBAAI,IAAI,CAAC,IAAI,IAAQ,IACjC,CACH,CAAC,CAAC,CAAC,CACH,MAAC,IAAI,sBAAK,IAAI,CAAC,GAAG,QAAI,IAAI,CAAC,KAAK,IAAQ,CACxC,IAXQ,IAAI,CAAC,GAAG,CAYZ,CACN,CAAC,EAEF,KAAC,IAAI,cAAE,IAAI,GAAQ,EACnB,KAAC,IAAI,IAAC,QAAQ,2FAA4E,EAC1F,KAAC,IAAI,IAAC,QAAQ,oCAAqB,IAC9B,CACN,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shadowdocs",
3
- "version": "2.1.6",
3
+ "version": "2.1.7",
4
4
  "description": "AI-powered documentation generator for developer projects",
5
5
  "type": "module",
6
6
  "main": "dist/interactive.js",
@@ -41,14 +41,9 @@ export default function Menu({ onSelect }: MenuProps) {
41
41
  return (
42
42
  <Box flexDirection="column" padding={1}>
43
43
  <Text bold color="cyan">
44
-
45
- ██╗ ██╗███████╗██████╗ ███████╗███████╗███╗ ███╗
46
- ██║ ██║██╔════╝██╔══██╗██╔════╝██╔════╝████╗ ████║
47
- ██║ █╗ ██║█████╗ ██████╔╝█████╗ █████╗ ██╔████╔██║
48
- ██║███╗██║██╔══╝ ██╔══██╗██╔══╝ ██╔══╝ ██║╚██╔╝██║
49
- ╚███╔███╔╝███████╗██║ ██║███████╗███████╗██║ ╚═╝ ██║
50
- ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝ ╚═╝
51
-
44
+ .-. . . .-. .-. .-. . . . .-. .-. .-. .-.
45
+ `-. |-| |-| | ) | | | | | | ) | | | `-.
46
+ `-' ' ` ` ' `-' `-' `.'.' `-' `-' `-' `-'
52
47
  </Text>
53
48
 
54
49
  <Text dimColor>AI-Powered Documentation Generator</Text>