shadowdocs 2.1.5 → 2.1.7

package/CONTRIBUTING.md

@@ -1,83 +1,51 @@
 # Contributing to ShadowDocs
+==========================
 
-Thank you for your interest in contributing to ShadowDocs!
-
-## Code of Conduct
-
-This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
-
-- Be respectful and inclusive
-- No harassment or discrimination
-- No offensive language or behavior
-- Violations will result in immediate account suspension
-
-## How to Contribute
-
-### Reporting Bugs
-
-1. Check existing issues first
-2. Create a detailed bug report with:
-   - Clear title and description
-   - Steps to reproduce
-   - Expected vs actual behavior
-   - Environment details (OS, Node version, etc.)
-
-### Suggesting Features
-
-1. Search existing feature requests
-2. Provide clear use case
-3. Explain why this feature would be useful
-4. Be open to discussion
-
-### Pull Requests
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feature/amazing-feature`
-3. Make your changes
-4. Add tests if applicable
-5. Ensure code style is consistent
-6. Commit with clear messages: `git commit -m 'Add amazing feature'`
-7. Push to your fork: `git push origin feature/amazing-feature`
-8. Open a Pull Request
+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.
 
 ## Development Setup
+--------------------
 
-```bash
-git clone https://github.com/shadowofficial206/shadowdocs.git
-cd shadowdocs
-npm install
-```
+To start contributing to ShadowDocs, follow these steps:
 
-### Running Locally
+1. **Clone the repository**: Clone the ShadowDocs repository using Git: `git clone https://github.com/[repository-url].git`
+2. **Install dependencies**: Install the required dependencies by running `npm install` or `yarn install` in the project root directory.
+3. **Build the project**: Run `npm run build` or `yarn build` to build the project.
+4. **Start the development server**: Run `npm run dev` or `yarn dev` to start the development server in watch mode.
 
-```bash
-npm install -g .
-shadowdocs
-```
+## Testing Requirements
+----------------------
 
-### Testing
+Before submitting changes, ensure that the following testing requirements are met:
 
-```bash
-npm test
-```
+1. **Type checking**: Run `npm run typecheck` or `yarn typecheck` to verify that the code is type-safe.
+2. **Unit tests**: Run `npm test` or `yarn test` to execute the unit tests.
+3. **Integration tests**: Run `npm run test:integration` or `yarn test:integration` to execute the integration tests.
 
-## Style Guide
+## Guidelines for Contributing
+-----------------------------
 
-- Use ESM modules (`import`/`export`)
-- Use async/await over promises
-- Keep functions small and focused
-- Add comments for complex logic
-- Use meaningful variable names
+1. **Code style**: Follow the existing code style and formatting conventions.
+2. **Commit messages**: Use descriptive and concise commit messages that follow the standard GitHub guidelines.
+3. **Pull requests**: Submit changes as pull requests, including a clear description of the changes and any relevant testing or verification.
+4. **Code reviews**: Participate in code reviews to ensure that changes meet the project's standards and requirements.
 
-## Questions?
+## Submitting Changes
+--------------------
 
-- Open an issue for questions
-- Don't open issues for general questions
+To submit changes to ShadowDocs, follow these steps:
 
-## Recognition
+1. **Create a new branch**: Create a new branch from the main branch using `git checkout -b [branch-name]`.
+2. **Make changes**: Make the desired changes to the codebase.
+3. **Commit changes**: Commit the changes using `git commit -m "[commit-message]"`.
+4. **Push changes**: Push the changes to the remote repository using `git push origin [branch-name]`.
+5. **Create a pull request**: Create a pull request from the new branch to the main branch, including a clear description of the changes.
 
-Contributors will be recognized in the README and on GitHub.
+## Additional Resources
+-----------------------
 
----
+* **Project structure**: Familiarize yourself with the project structure, including the `src`, `bin`, and `ui` directories.
+* **Dependencies**: Review the project dependencies and dev dependencies listed in `package.json`.
+* **Security**: Review the security guidelines and best practices outlined in `SECURITY.md`.
 
-**By contributing, you agree to abide by our terms and the MIT License.**
+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

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ShadowDocs
+Copyright (c) 2024 shadowdocs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,100 +1,141 @@
 # ShadowDocs
-## Overview
-ShadowDocs is an AI-powered documentation generator for developer projects, designed to simplify the process of creating and maintaining high-quality documentation. The project aims to provide an efficient and effective solution for developers to generate documentation with ease. By leveraging AI technology, ShadowDocs automates the documentation process, saving developers time and effort.
-
-## Version
-Current version: 2.0.0
-
-## Description
-ShadowDocs is a module designed for developers who want to generate high-quality documentation for their projects without the hassle of manual writing. The project uses AI technology to analyze the codebase and generate documentation automatically. ShadowDocs is ideal for developers who want to focus on writing code rather than documentation. With its interactive and intuitive interface, ShadowDocs makes it easy for developers to generate documentation that is accurate, up-to-date, and easy to understand.
-
-## Features
-- AI-powered documentation generation
-- Automatic code analysis
-- Interactive documentation interface
-- Support for multiple programming languages
-- Customizable configuration options
-
+================
+AI-powered documentation generator for developer projects.
+
+## Table of Contents
+-----------------
+
+1. [Introduction](#introduction)
+2. [Getting Started](#getting-started)
+3. [Project Structure](#project-structure)
+4. [Installation](#installation)
+5. [Usage](#usage)
+6. [API Documentation](#api-documentation)
+7. [Contributing](#contributing)
+8. [Security](#security)
+9. [License](#license)
+
+## Introduction
+------------
+
+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.
+
+## Getting Started
+---------------
+
+To get started with ShadowDocs, follow these steps:
+
+1. Install the required dependencies using npm or yarn.
+2. Run the `build` script to compile the TypeScript code.
+3. Run the `start` script to start the ShadowDocs CLI.
+
+## Project Structure
+------------------
+
+The ShadowDocs project is structured as follows:
+```markdown
+shadowdocs/
+  ├── bin/
+    ├── cli.js
+  ├── src/
+    ├── core/
+      ├── config.ts
+      ├── events.ts
+      ├── index.ts
+      ├── types.ts
+      ├── ui.ts
+    ├── services/
+      ├── ai.ts
+      ├── analyzer.ts
+      ├── index.ts
+      ├── scanner.ts
+    ├── ui/
+      ├── components/
+      ├── contexts/
+      ├── hooks/
+      ├── App.tsx
+    ├── cli-ink.ts
+    ├── ink.tsx
+    ├── interactive.ts
+  ├── CONTRIBUTING.md
+  ├── LICENSE
+  ├── package-lock.json
+  ├── package.json
+  ├── README.md
+  ├── SECURITY.md
+  ├── shadowdocs-2.0.1.tgz
+  ├── tsconfig.json
+```
 ## Installation
+------------
+
 To install ShadowDocs, run the following command:
 ```bash
 npm install shadowdocs
 ```
-
-## Usage
-To use ShadowDocs, follow these steps:
-```javascript
-// Import ShadowDocs
-const { generateDocs } = require('shadowdocs');
-
-// Generate documentation
-generateDocs({
-  // Project path
-  path: './my-project',
-  // Output path
-  output: './docs',
-});
+or
+```bash
+yarn add shadowdocs
 ```
+## Usage
+-----
 
-## API Reference
-ShadowDocs exports the following functions:
-- `generateDocs(options)`: Generates documentation for a project.
-  - `options.path`: The path to the project.
-  - `options.output`: The output path for the generated documentation.
-
-## Configuration
-ShadowDocs provides the following configuration options:
-- `path`: The path to the project.
-- `output`: The output path for the generated documentation.
-- `language`: The programming language of the project.
-
-## Development
-To set up the development environment, run the following commands:
+To use ShadowDocs, run the following command:
 ```bash
-npm install
-npm run dev
+npx shadowdocs
 ```
-This will start the development server and watch for changes to the code.
+This will start the ShadowDocs CLI. You can then follow the prompts to generate documentation for your project.
 
-## Testing
-To run tests, use the following command:
+### Example Usage
+
+Here is an example of how to use ShadowDocs to generate documentation for a sample project:
 ```bash
-npm run typecheck
+# Create a new project
+mkdir myproject
+cd myproject
+
+# Initialize a new npm project
+npm init -y
+
+# Install ShadowDocs
+npm install shadowdocs
+
+# Run ShadowDocs
+npx shadowdocs
 ```
-This will run the type checker and ensure that the code is correct.
+This will generate documentation for the `myproject` project.
 
-## License
-MIT License
+## API Documentation
+------------------
 
-Copyright (c) 2023 ShadowDocs
+The ShadowDocs API is documented below:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+### Core
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+* `config.ts`: Configuration module for ShadowDocs.
+* `events.ts`: Event handling module for ShadowDocs.
+* `index.ts`: Main entry point for ShadowDocs.
+* `types.ts`: Type definitions for ShadowDocs.
+* `ui.ts`: UI component module for ShadowDocs.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+### Services
+
+* `ai.ts`: AI-powered documentation generation module.
+* `analyzer.ts`: Code analysis module for ShadowDocs.
+* `index.ts`: Main entry point for services module.
+* `scanner.ts`: Code scanner module for ShadowDocs.
 
 ## Contributing
-Contribution Guidelines:
-- Fork the repository and create a feature branch.
-- Follow the existing code style and conventions.
-- Add tests if applicable to ensure that the code is correct.
-- Submit a pull request with a clear description of the changes.
+------------
+
+To contribute to ShadowDocs, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Security
+---------
 
-## Security Policy
-If you discover a vulnerability in ShadowDocs, please report it to the maintainers immediately. You can report vulnerabilities by emailing the maintainers or by submitting an issue on the repository.
+To report a security vulnerability, please see the [SECURITY.md](SECURITY.md) file.
+
+## License
+-------
 
-## Code of Conduct
-We are committed to creating a welcoming and inclusive environment for all contributors. We expect all contributors to be respectful, inclusive, and professional. Harassment, discrimination, or any other form of unacceptable behavior will not be tolerated and will result in immediate suspension of privileges.
+ShadowDocs is licensed under the [MIT License](LICENSE).

package/SECURITY.md

@@ -1,52 +1,35 @@
-# Security Policy
+# SECURITY.md
+## Introduction
+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.
 
-## Supported Versions
+## Reporting Security Vulnerabilities
+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.
 
-| Version | Supported          |
-| ------- | ------------------- |
-| 1.2.x   | ✓ :white_check_mark: |
-| 1.1.x   | ✓ :white_check_mark: |
-| < 1.1   | ✗                  |
+To report a security vulnerability, please follow these steps:
 
-## Reporting a Vulnerability
+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".
+2. Provide a detailed description of the vulnerability, including:
+	* A clear explanation of the issue
+	* Steps to reproduce the issue (if applicable)
+	* Any relevant code snippets or logs
+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.
 
-If you discover a security vulnerability within ShadowDocs, please send an email to security@shadowdocs.app.
+## Security Information
+The shadowdocs project uses the following security measures:
 
-All security vulnerabilities will be promptly addressed.
-
-## What to Include
-
-- Description of the vulnerability
-- Steps to reproduce
-- Potential impact
-- Any suggested fixes (optional)
-
-## Scope
-
-- API key exposure vulnerabilities
-- Code injection risks
-- Data privacy issues
-- Authentication/authorization bypasses
-
-## Out of Scope
-
-- Social engineering attacks
-- Physical security
-- Denial of service (unless severe)
-- Issues in third-party dependencies (report to maintainers)
+* **Dependencies**: We regularly review and update our dependencies to ensure we are using the latest secure versions.
+* **Code Reviews**: All code changes are reviewed by at least one other developer before being merged into the main branch.
+* **Testing**: We have a comprehensive test suite to ensure our code is working as expected.
 
 ## Response Timeline
+We strive to address security vulnerabilities in a timely and responsible manner. Our response timeline is as follows:
 
-- Acknowledge: 24-48 hours
-- Initial assessment: 3-5 days
-- Fix released: Based on severity
-
-## Security Updates
-
-Security updates will be released as patch versions and announced on:
-- GitHub Security Advisories
-- npm security alerts
+* **Acknowledgement**: We will respond to your initial report within **3 business days** to acknowledge receipt of your report.
+* **Initial Fix**: We will provide an initial fix for the vulnerability within **7 business days** of acknowledging the report.
+* **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.
 
----
+## Contact Information
+For any security-related questions or concerns, please contact us at [security@shadowdocs.io](mailto:security@shadowdocs.io).
 
-**Do not open public issues for security vulnerabilities.**
+## Versioning
+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.

package/dist/services/ai.d.ts

@@ -1,4 +1,11 @@
 import { DocResult } from '../core/types.js';
+export interface GeneratedDocs {
+    content?: string;
+    readme: string;
+    contributing: string;
+    license: string;
+    security: string;
+}
 export declare function generateDocs(projectData: Record<string, unknown>, mode?: 'generate' | 'improve' | 'explain'): Promise<DocResult>;
 export declare function validateApiKey(apiKey: string): Promise<boolean>;
 //# sourceMappingURL=ai.d.ts.map

package/dist/services/ai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../../src/services/ai.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AA6D7C,wBAAsB,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,GAAE,UAAU,GAAG,SAAS,GAAG,SAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,CA8BlJ;AA0HD,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CA2BrE"}
+{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../../src/services/ai.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AA6D7C,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wBAAsB,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,GAAE,UAAU,GAAG,SAAS,GAAG,SAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,CA+ClJ;AA0MD,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CA2BrE"}