Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1b0eac8fa0 | |||
| 7166e66880 | |||
| 53a21e2f81 | |||
| 5d43c80fe5 | |||
| d6609befd5 | |||
| e85349496e | |||
| 078dde19f6 | |||
| aa7c1caac3 | |||
| 71f4b4c68b | |||
| 5cab291b83 | |||
| 1d7b9c75ff | |||
| 4a19e7c0ee | |||
| 31c129bf2a | |||
| 2958490f28 | |||
| d3ded89261 | |||
| 04db184914 | |||
| 040a316809 | |||
| 9a31e6d0be | |||
| 7e4c7d60ea | |||
| 00eae893f5 | |||
| a43d6a926e |
@@ -31,4 +31,4 @@ jobs:
|
|||||||
run: pytest -xvs --tb=short
|
run: pytest -xvs --tb=short
|
||||||
|
|
||||||
- name: Run linting
|
- name: Run linting
|
||||||
run: ruff check .
|
run: ruff check project_scaffold_cli tests setup.py
|
||||||
|
|||||||
19
.github/workflows/ci.yml
vendored
Normal file
19
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: '3.11'
|
||||||
|
- run: pip install -e ".[dev]"
|
||||||
|
- run: pytest tests/ -v
|
||||||
|
- run: ruff check .
|
||||||
56
.gitignore
vendored
56
.gitignore
vendored
@@ -1,3 +1,4 @@
|
|||||||
|
# Python
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
*$py.class
|
*$py.class
|
||||||
@@ -14,50 +15,25 @@ lib64/
|
|||||||
parts/
|
parts/
|
||||||
sdist/
|
sdist/
|
||||||
var/
|
var/
|
||||||
wheels/
|
wheel/
|
||||||
*.egg-info/
|
*.egg-info/
|
||||||
.installed.cfg
|
.installed.cfg
|
||||||
*.egg
|
*.egg
|
||||||
venv/
|
|
||||||
ENV/
|
# IDEs
|
||||||
env/
|
|
||||||
.venv/
|
|
||||||
.idea/
|
|
||||||
.vscode/
|
.vscode/
|
||||||
|
.idea/
|
||||||
*.swp
|
*.swp
|
||||||
*.swo
|
*.swo
|
||||||
*~
|
*
|
||||||
.pydevproject
|
|
||||||
.tox/
|
# Environment
|
||||||
.nox/
|
.env
|
||||||
.coverage
|
.venv
|
||||||
.coverage.*
|
env/
|
||||||
htmlcov/
|
venv/
|
||||||
.pytest_cache/
|
ENV/
|
||||||
nosetests.xml
|
|
||||||
coverage.xml
|
# OS
|
||||||
*.cover
|
|
||||||
*.py,cover
|
|
||||||
logs/
|
|
||||||
*.log
|
|
||||||
*.db
|
|
||||||
*.sqlite
|
|
||||||
*.sqlite3
|
|
||||||
workspace/
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
.DS_Store?
|
Thumbs.db
|
||||||
._*
|
|
||||||
.Spotlight-V100
|
|
||||||
.Trashes
|
|
||||||
ehthumbs.db
|
|
||||||
Thumbs.db
|
|
||||||
.docker/
|
|
||||||
tmp/
|
|
||||||
temp/
|
|
||||||
*.tmp
|
|
||||||
*.temp
|
|
||||||
*.pem
|
|
||||||
*.key
|
|
||||||
secrets/
|
|
||||||
*.readme_generated
|
|
||||||
.readme_cache/
|
|
||||||
238
README.md
238
README.md
@@ -1,249 +1,27 @@
|
|||||||
# Project Scaffold CLI
|
# Project Scaffold CLI
|
||||||
|
|
||||||
A CLI tool that generates standardized project scaffolding for multiple languages (Python, Node.js, Go, Rust) with intelligent defaults, auto-generated configs, CI/CD templates, and custom template support.
|
A CLI tool that generates standardized project scaffolding for multiple languages.
|
||||||
|
|
||||||
[](https://opensource.org/licenses/MIT)
|
|
||||||
[](https://www.python.org/downloads/)
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Multi-language templates**: Pre-built templates for Python, Node.js, Go, and Rust projects
|
- Multi-language support (Python, JavaScript, Go, Rust)
|
||||||
- **Interactive prompts**: Interactive CLI prompts for project configuration
|
- Automated project structure generation
|
||||||
- **Gitignore generation**: Auto-generate language-specific .gitignore files based on best practices
|
- Dependency analysis and documentation
|
||||||
- **CI/CD templates**: Generate CI/CD pipeline templates for GitHub Actions and GitLab CI
|
- Template-based scaffolding
|
||||||
- **Custom template support**: Allow users to create, save, and share custom project templates
|
- Configuration management
|
||||||
- **Configuration file**: Support project.yaml or .project-scaffoldrc for default configurations
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### From PyPI
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install project-scaffold-cli
|
pip install project-scaffold-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
### From Source
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://7000pct.gitea.bloupla.net/7000pctAUTO/project-scaffold-cli.git
|
|
||||||
cd project-scaffold-cli
|
|
||||||
pip install -e .
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
### Generate a Python project
|
|
||||||
|
|
||||||
```bash
|
|
||||||
psc create my-python-project --language python
|
|
||||||
```
|
|
||||||
|
|
||||||
### Generate a Node.js project
|
|
||||||
|
|
||||||
```bash
|
|
||||||
psc create my-nodejs-project --language nodejs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Generate with CI/CD templates
|
|
||||||
|
|
||||||
```bash
|
|
||||||
psc create my-project --language python --ci github
|
|
||||||
```
|
|
||||||
|
|
||||||
### Interactive Mode
|
|
||||||
|
|
||||||
```bash
|
|
||||||
psc create
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Commands
|
|
||||||
|
|
||||||
#### create
|
|
||||||
|
|
||||||
Create a new project scaffold.
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
psc create [OPTIONS] [PROJECT_NAME]
|
psc --help
|
||||||
```
|
```
|
||||||
|
|
||||||
**Options:**
|
|
||||||
|
|
||||||
| Option | Description |
|
|
||||||
|--------|-------------|
|
|
||||||
| `-l, --language TEXT` | Project language (python, nodejs, go, rust) |
|
|
||||||
| `-a, --author TEXT` | Author name |
|
|
||||||
| `-e, --email TEXT` | Author email |
|
|
||||||
| `-d, --description TEXT` | Project description |
|
|
||||||
| `-L, --license TEXT` | License (MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, None) |
|
|
||||||
| `--ci TEXT` | CI/CD provider (github, gitlab, none) |
|
|
||||||
| `-t, --template TEXT` | Custom template path or name |
|
|
||||||
| `-c, --config FILE` | Path to configuration file |
|
|
||||||
| `--yes` | Skip prompts and use defaults |
|
|
||||||
| `--force` | Force overwrite existing directory |
|
|
||||||
|
|
||||||
#### template
|
|
||||||
|
|
||||||
Manage custom templates.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
psc template [OPTIONS] COMMAND [ARGS]...
|
|
||||||
```
|
|
||||||
|
|
||||||
**Subcommands:**
|
|
||||||
|
|
||||||
- `list` - List all custom templates
|
|
||||||
- `save` - Save a new custom template
|
|
||||||
- `delete` - Delete a custom template
|
|
||||||
|
|
||||||
#### init-config
|
|
||||||
|
|
||||||
Generate a template configuration file.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
psc init-config --output project.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
### Configuration File (project.yaml)
|
|
||||||
|
|
||||||
Create a `project.yaml` file in your project root:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
project:
|
|
||||||
author: "Your Name"
|
|
||||||
email: "your.email@example.com"
|
|
||||||
license: "MIT"
|
|
||||||
description: "A brief description of your project"
|
|
||||||
|
|
||||||
defaults:
|
|
||||||
language: "python"
|
|
||||||
ci: "github"
|
|
||||||
template: null
|
|
||||||
|
|
||||||
template_vars:
|
|
||||||
python:
|
|
||||||
version: "3.8+"
|
|
||||||
nodejs:
|
|
||||||
version: "16+"
|
|
||||||
```
|
|
||||||
|
|
||||||
### User Configuration (~/.config/project-scaffold/config.yaml)
|
|
||||||
|
|
||||||
User-level configuration for custom template paths:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
template_paths:
|
|
||||||
- ~/.local/share/project-scaffold/templates
|
|
||||||
custom_templates_dir: ~/.config/project-scaffold/templates
|
|
||||||
```
|
|
||||||
|
|
||||||
## Supported Languages
|
|
||||||
|
|
||||||
| Language | Files Generated |
|
|
||||||
|----------|---------------|
|
|
||||||
| Python | setup.py, requirements.txt, README.md, __init__.py, cli.py, test_main.py |
|
|
||||||
| Node.js | package.json, index.js, README.md |
|
|
||||||
| Go | go.mod, main.go, README.md |
|
|
||||||
| Rust | Cargo.toml, src/main.rs, README.md |
|
|
||||||
|
|
||||||
## Custom Templates
|
|
||||||
|
|
||||||
### Creating Custom Templates
|
|
||||||
|
|
||||||
1. Create a template directory with your project structure
|
|
||||||
2. Use Jinja2 syntax for variables: `{{ project_name }}`
|
|
||||||
3. Save the template using `psc template save`
|
|
||||||
|
|
||||||
### Template Variables
|
|
||||||
|
|
||||||
Available variables for all templates:
|
|
||||||
|
|
||||||
- `{{ project_name }}` - Project directory name
|
|
||||||
- `{{ project_slug }}` - kebab-case project name
|
|
||||||
- `{{ author }}` - Author name
|
|
||||||
- `{{ email }}` - Author email
|
|
||||||
- `{{ description }}` - Project description
|
|
||||||
- `{{ license }}` - License name
|
|
||||||
- `{{ year }}` - Current year
|
|
||||||
- `{{ language }}` - Programming language
|
|
||||||
|
|
||||||
## CI/CD Support
|
|
||||||
|
|
||||||
### GitHub Actions
|
|
||||||
|
|
||||||
Generate `.github/workflows/ci.yml` with:
|
|
||||||
- Linting
|
|
||||||
- Testing
|
|
||||||
- Code coverage
|
|
||||||
|
|
||||||
### GitLab CI
|
|
||||||
|
|
||||||
Generate `.gitlab-ci.yml` with:
|
|
||||||
- Build stages
|
|
||||||
- Test jobs
|
|
||||||
- Deployment steps
|
|
||||||
|
|
||||||
## Project Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
project-scaffold-cli/
|
|
||||||
├── project_scaffold_cli/
|
|
||||||
│ ├── __init__.py
|
|
||||||
│ ├── cli.py # Main CLI interface
|
|
||||||
│ ├── template_engine.py # Jinja2 template rendering
|
|
||||||
│ ├── config.py # Configuration handling
|
|
||||||
│ ├── prompts.py # Interactive prompts
|
|
||||||
│ ├── gitignore.py # .gitignore generation
|
|
||||||
│ └── templates/ # Built-in templates
|
|
||||||
│ ├── python/
|
|
||||||
│ ├── nodejs/
|
|
||||||
│ ├── go/
|
|
||||||
│ ├── rust/
|
|
||||||
│ └── ci/
|
|
||||||
├── tests/ # Test suite
|
|
||||||
├── docs/ # Documentation
|
|
||||||
├── setup.py
|
|
||||||
├── setup.cfg
|
|
||||||
├── requirements.txt
|
|
||||||
├── requirements-dev.txt
|
|
||||||
└── README.md
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
### Setting up Development Environment
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://7000pct.gitea.bloupla.net/7000pctAUTO/project-scaffold-cli.git
|
|
||||||
cd project-scaffold-cli
|
|
||||||
pip install -e ".[dev]"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running Tests
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pytest -v --cov=project_scaffold_cli --cov-report=term-missing
|
|
||||||
```
|
|
||||||
|
|
||||||
### Code Formatting
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ruff check --fix .
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Contributions are welcome!
|
|
||||||
|
|
||||||
1. Fork the repository
|
|
||||||
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
|
||||||
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
|
||||||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
|
||||||
5. Open a Pull Request
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
MIT
|
||||||
1
app/project_scaffold_cli/cli.py
Normal file
1
app/project_scaffold_cli/cli.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"project_scaffold_cli/cli.py": "" + "" + "# File content follows" + ""}
|
||||||
1
app/project_scaffold_cli/config.py
Normal file
1
app/project_scaffold_cli/config.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"project_scaffold_cli/config.py": "" + "" + "# File content follows" + ""}
|
||||||
1
app/project_scaffold_cli/gitignore.py
Normal file
1
app/project_scaffold_cli/gitignore.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"project_scaffold_cli/gitignore.py": "" + "" + "# File content follows" + ""}
|
||||||
1
app/project_scaffold_cli/template_engine.py
Normal file
1
app/project_scaffold_cli/template_engine.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"project_scaffold_cli/template_engine.py": "" + "" + "# File content follows" + ""}
|
||||||
68
pyproject.toml
Normal file
68
pyproject.toml
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=61.0", "wheel"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "project-scaffold-cli"
|
||||||
|
version = "1.0.0"
|
||||||
|
description = "A CLI tool that generates standardized project scaffolding for multiple languages"
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.8"
|
||||||
|
license = {text = "MIT"}
|
||||||
|
authors = [
|
||||||
|
{name = "Project Scaffold CLI", email = "dev@example.com"}
|
||||||
|
]
|
||||||
|
keywords = ["cli", "project", "scaffold", "generator", "template"]
|
||||||
|
classifiers = [
|
||||||
|
"Development Status :: 4 - Beta",
|
||||||
|
"Environment :: Console",
|
||||||
|
"Intended Audience :: Developers",
|
||||||
|
"License :: OSI Approved :: MIT License",
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"Programming Language :: Python :: 3.8",
|
||||||
|
"Programming Language :: Python :: 3.9",
|
||||||
|
"Programming Language :: Python :: 3.10",
|
||||||
|
"Programming Language :: Python :: 3.11",
|
||||||
|
"Programming Language :: Python :: 3.12",
|
||||||
|
]
|
||||||
|
|
||||||
|
dependencies = [
|
||||||
|
"click>=8.0",
|
||||||
|
"jinja2>=3.0",
|
||||||
|
"pyyaml>=6.0",
|
||||||
|
"click-completion>=0.2",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"pytest>=7.0",
|
||||||
|
"pytest-cov>=4.0",
|
||||||
|
"ruff>=0.1.0",
|
||||||
|
]
|
||||||
|
|
||||||
|
[tool.pytest.ini_options]
|
||||||
|
testpaths = ["tests"]
|
||||||
|
python_files = ["test_*.py"]
|
||||||
|
python_classes = ["Test*"]
|
||||||
|
python_functions = ["test_*"]
|
||||||
|
addopts = "-v --tb=short"
|
||||||
|
|
||||||
|
[tool.coverage.run]
|
||||||
|
source = ["project_scaffold_cli"]
|
||||||
|
omit = ["*/tests/*", "*/__pycache__/*"]
|
||||||
|
|
||||||
|
[tool.coverage.report]
|
||||||
|
exclude_lines = ["pragma: no cover", "def __repr__", "raise NotImplementedError"]
|
||||||
|
|
||||||
|
[tool.black]
|
||||||
|
line-length = 100
|
||||||
|
target-version = ["py38", "py39", "py310", "py311", "py312"]
|
||||||
|
include = "\\.pyi?$"
|
||||||
|
|
||||||
|
[tool.ruff]
|
||||||
|
line-length = 100
|
||||||
|
target-version = "py38"
|
||||||
|
|
||||||
|
[tool.ruff.lint]
|
||||||
|
select = ["E", "F", "W", "I"]
|
||||||
|
ignore = ["E501"]
|
||||||
@@ -2,3 +2,4 @@ pytest>=7.0
|
|||||||
pytest-cov>=4.0
|
pytest-cov>=4.0
|
||||||
black>=23.0
|
black>=23.0
|
||||||
flake8>=6.0
|
flake8>=6.0
|
||||||
|
ruff>=0.1.0
|
||||||
|
|||||||
7
setup.py
7
setup.py
@@ -1,4 +1,4 @@
|
|||||||
from setuptools import setup, find_packages
|
from setuptools import find_packages, setup
|
||||||
|
|
||||||
with open("README.md", "r", encoding="utf-8") as fh:
|
with open("README.md", "r", encoding="utf-8") as fh:
|
||||||
long_description = fh.read()
|
long_description = fh.read()
|
||||||
@@ -11,7 +11,7 @@ setup(
|
|||||||
description="A CLI tool that generates standardized project scaffolding for multiple languages",
|
description="A CLI tool that generates standardized project scaffolding for multiple languages",
|
||||||
long_description=long_description,
|
long_description=long_description,
|
||||||
long_description_content_type="text/markdown",
|
long_description_content_type="text/markdown",
|
||||||
url="https://7000pct.gitea.bloupla.net/7000pctAUTO/project-scaffold-cli",
|
url="https://github.com/example/project-scaffold-cli",
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
python_requires=">=3.8",
|
python_requires=">=3.8",
|
||||||
install_requires=[
|
install_requires=[
|
||||||
@@ -24,8 +24,7 @@ setup(
|
|||||||
"dev": [
|
"dev": [
|
||||||
"pytest>=7.0",
|
"pytest>=7.0",
|
||||||
"pytest-cov>=4.0",
|
"pytest-cov>=4.0",
|
||||||
"black>=23.0",
|
"ruff>=0.1.0",
|
||||||
"flake8>=6.0",
|
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
entry_points={
|
entry_points={
|
||||||
|
|||||||
204
tests/conftest.py
Normal file
204
tests/conftest.py
Normal file
@@ -0,0 +1,204 @@
|
|||||||
|
"""Test configuration and fixtures."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def create_python_project(tmp_path: Path) -> Path:
|
||||||
|
"""Create a Python project structure for testing."""
|
||||||
|
src_dir = tmp_path / "src"
|
||||||
|
src_dir.mkdir()
|
||||||
|
|
||||||
|
(src_dir / "__init__.py").write_text('"""Package init."""')
|
||||||
|
|
||||||
|
(src_dir / "main.py").write_text('"""Main module."""
|
||||||
|
|
||||||
|
def hello():
|
||||||
|
"""Say hello."""
|
||||||
|
print("Hello, World!")
|
||||||
|
|
||||||
|
class Calculator:
|
||||||
|
"""A simple calculator."""
|
||||||
|
|
||||||
|
def add(self, a: int, b: int) -> int:
|
||||||
|
"""Add two numbers."""
|
||||||
|
return a + b
|
||||||
|
|
||||||
|
def multiply(self, a: int, b: int) -> int:
|
||||||
|
"""Multiply two numbers."""
|
||||||
|
return a * b
|
||||||
|
')
|
||||||
|
|
||||||
|
(tmp_path / "requirements.txt").write_text('requests>=2.31.0
|
||||||
|
click>=8.0.0
|
||||||
|
pytest>=7.0.0
|
||||||
|
')
|
||||||
|
|
||||||
|
(tmp_path / "pyproject.toml").write_text('[build-system]
|
||||||
|
requires = ["setuptools"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "test-project"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "A test project"
|
||||||
|
requires-python = ">=3.9"
|
||||||
|
|
||||||
|
dependencies = [
|
||||||
|
"requests>=2.31.0",
|
||||||
|
"click>=8.0.0",
|
||||||
|
]
|
||||||
|
')
|
||||||
|
|
||||||
|
return tmp_path
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def create_javascript_project(tmp_path: Path) -> Path:
|
||||||
|
"""Create a JavaScript project structure for testing."""
|
||||||
|
(tmp_path / "package.json").write_text('{
|
||||||
|
"name": "test-js-project",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "A test JavaScript project",
|
||||||
|
"main": "index.js",
|
||||||
|
"dependencies": {
|
||||||
|
"express": "^4.18.0",
|
||||||
|
"lodash": "^4.17.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"jest": "^29.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
')
|
||||||
|
|
||||||
|
(tmp_path / "index.js").write_text('const express = require(\'express\');
|
||||||
|
const _ = require(\'lodash\');
|
||||||
|
|
||||||
|
function hello() {
|
||||||
|
return \'Hello, World!\';
|
||||||
|
}
|
||||||
|
|
||||||
|
class Calculator {
|
||||||
|
add(a, b) {
|
||||||
|
return a + b;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { hello, Calculator };
|
||||||
|
')
|
||||||
|
|
||||||
|
return tmp_path
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def create_go_project(tmp_path: Path) -> Path:
|
||||||
|
"""Create a Go project structure for testing."""
|
||||||
|
(tmp_path / "go.mod").write_text('module test-go-project
|
||||||
|
|
||||||
|
go 1.21
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/gin-gonic/gin v1.9.0
|
||||||
|
github.com/stretchr/testify v1.8.0
|
||||||
|
)
|
||||||
|
')
|
||||||
|
|
||||||
|
(tmp_path / "main.go").write_text('package main
|
||||||
|
|
||||||
|
import "fmt"
|
||||||
|
|
||||||
|
func hello() string {
|
||||||
|
return "Hello, World!"
|
||||||
|
}
|
||||||
|
|
||||||
|
type Calculator struct{}
|
||||||
|
|
||||||
|
func (c *Calculator) Add(a, b int) int {
|
||||||
|
return a + b
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(hello())
|
||||||
|
}
|
||||||
|
')
|
||||||
|
|
||||||
|
return tmp_path
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def create_rust_project(tmp_path: Path) -> Path:
|
||||||
|
"""Create a Rust project structure for testing."""
|
||||||
|
src_dir = tmp_path / "src"
|
||||||
|
src_dir.mkdir()
|
||||||
|
|
||||||
|
(tmp_path / "Cargo.toml").write_text('[package]
|
||||||
|
name = "test-rust-project"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
|
tokio = { version = "1.0", features = "full" }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
assertions = "0.1"
|
||||||
|
')
|
||||||
|
|
||||||
|
(src_dir / "main.rs").write_text('fn hello() -> String {
|
||||||
|
"Hello, World!".to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct Calculator;
|
||||||
|
|
||||||
|
impl Calculator {
|
||||||
|
pub fn add(a: i32, b: i32) -> i32 {
|
||||||
|
a + b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
println!("{}", hello());
|
||||||
|
}
|
||||||
|
')
|
||||||
|
|
||||||
|
return tmp_path
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def create_mixed_project(tmp_path: Path) -> Path:
|
||||||
|
"""Create a project with multiple languages for testing."""
|
||||||
|
python_part = tmp_path / "python_part"
|
||||||
|
python_part.mkdir()
|
||||||
|
js_part = tmp_path / "js_part"
|
||||||
|
js_part.mkdir()
|
||||||
|
|
||||||
|
src_dir = python_part / "src"
|
||||||
|
src_dir.mkdir()
|
||||||
|
(src_dir / "__init__.py").write_text('"""Package init."""')
|
||||||
|
(src_dir / "main.py").write_text('"""Main module."""
|
||||||
|
def hello():
|
||||||
|
print("Hello")
|
||||||
|
')
|
||||||
|
(python_part / "pyproject.toml").write_text('[project]
|
||||||
|
name = "test-project"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "A test project"
|
||||||
|
requires-python = ">=3.9"
|
||||||
|
dependencies = ["requests>=2.31.0"]
|
||||||
|
')
|
||||||
|
|
||||||
|
(js_part / "package.json").write_text('{
|
||||||
|
"name": "test-js-project",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "A test project"
|
||||||
|
}
|
||||||
|
')
|
||||||
|
(js_part / "index.js").write_text('function hello() {
|
||||||
|
return \'Hello\';
|
||||||
|
}
|
||||||
|
module.exports = { hello };
|
||||||
|
')
|
||||||
|
|
||||||
|
return tmp_path
|
||||||
254
tests/test_analyzers.py
Normal file
254
tests/test_analyzers.py
Normal file
@@ -0,0 +1,254 @@
|
|||||||
|
"""Tests for code analyzers."""
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from src.auto_readme.analyzers import (
|
||||||
|
CodeAnalyzerFactory,
|
||||||
|
GoAnalyzer,
|
||||||
|
JavaScriptAnalyzer,
|
||||||
|
PythonAnalyzer,
|
||||||
|
RustAnalyzer,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestPythonAnalyzer:
|
||||||
|
"""Tests for PythonAnalyzer."""
|
||||||
|
|
||||||
|
def test_can_analyze_py_file(self):
|
||||||
|
"""Test that analyzer recognizes Python files."""
|
||||||
|
analyzer = PythonAnalyzer()
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".py", delete=False, mode="w") as f:
|
||||||
|
f.write("def hello():\n pass")
|
||||||
|
f.flush()
|
||||||
|
assert analyzer.can_analyze(Path(f.name))
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_can_analyze_pyi_file(self):
|
||||||
|
"""Test that analyzer recognizes .pyi stub files."""
|
||||||
|
analyzer = PythonAnalyzer()
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".pyi", delete=False, mode="w") as f:
|
||||||
|
f.write("def hello() -> None: ...")
|
||||||
|
f.flush()
|
||||||
|
assert analyzer.can_analyze(Path(f.name))
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_analyze_simple_function(self):
|
||||||
|
"""Test analyzing a simple function."""
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".py", delete=False, mode="w") as f:
|
||||||
|
f.write('"""Module docstring."""
|
||||||
|
|
||||||
|
def hello():
|
||||||
|
"""Say hello."""
|
||||||
|
print("Hello, World!")
|
||||||
|
|
||||||
|
class Calculator:
|
||||||
|
"""A calculator class."""
|
||||||
|
|
||||||
|
def add(self, a, b):
|
||||||
|
"""Add two numbers."""
|
||||||
|
return a + b
|
||||||
|
')
|
||||||
|
f.flush()
|
||||||
|
file_path = Path(f.name)
|
||||||
|
analyzer = PythonAnalyzer()
|
||||||
|
result = analyzer.analyze(file_path)
|
||||||
|
|
||||||
|
assert len(result["functions"]) == 2 # hello and add
|
||||||
|
assert len(result["classes"]) == 1
|
||||||
|
|
||||||
|
hello_func = next((f for f in result["functions"] if f.name == "hello"), None)
|
||||||
|
assert hello_func is not None
|
||||||
|
assert hello_func.docstring == "Say hello."
|
||||||
|
assert hello_func.parameters == []
|
||||||
|
|
||||||
|
calc_class = result["classes"][0]
|
||||||
|
assert calc_class.name == "Calculator"
|
||||||
|
assert calc_class.docstring == "A calculator class."
|
||||||
|
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_analyze_with_parameters(self):
|
||||||
|
"""Test analyzing functions with parameters."""
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".py", delete=False, mode="w") as f:
|
||||||
|
f.write('def greet(name, greeting="Hello"):
|
||||||
|
"""Greet someone."""
|
||||||
|
return f"{greeting}, {name}!"
|
||||||
|
|
||||||
|
def add_numbers(a: int, b: int) -> int:
|
||||||
|
"""Add two integers."""
|
||||||
|
return a + b
|
||||||
|
')
|
||||||
|
f.flush()
|
||||||
|
file_path = Path(f.name)
|
||||||
|
analyzer = PythonAnalyzer()
|
||||||
|
result = analyzer.analyze(file_path)
|
||||||
|
|
||||||
|
greet_func = next((f for f in result["functions"] if f.name == "greet"), None)
|
||||||
|
assert greet_func is not None
|
||||||
|
assert "name" in greet_func.parameters
|
||||||
|
assert "greeting" in greet_func.parameters
|
||||||
|
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
|
||||||
|
class TestJavaScriptAnalyzer:
|
||||||
|
"""Tests for JavaScriptAnalyzer."""
|
||||||
|
|
||||||
|
def test_can_analyze_js_file(self):
|
||||||
|
"""Test that analyzer recognizes JavaScript files."""
|
||||||
|
analyzer = JavaScriptAnalyzer()
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".js", delete=False, mode="w") as f:
|
||||||
|
f.write("function hello() { return 'hello'; }")
|
||||||
|
f.flush()
|
||||||
|
assert analyzer.can_analyze(Path(f.name))
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_can_analyze_ts_file(self):
|
||||||
|
"""Test that analyzer recognizes TypeScript files."""
|
||||||
|
analyzer = JavaScriptAnalyzer()
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".ts", delete=False, mode="w") as f:
|
||||||
|
f.write("const hello = (): string => 'hello';")
|
||||||
|
f.flush()
|
||||||
|
assert analyzer.can_analyze(Path(f.name))
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_analyze_simple_function(self):
|
||||||
|
"""Test analyzing a simple JavaScript function."""
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".js", delete=False, mode="w") as f:
|
||||||
|
f.write('function hello(name) {
|
||||||
|
return "Hello, " + name + "!";
|
||||||
|
}
|
||||||
|
|
||||||
|
class Calculator {
|
||||||
|
add(a, b) {
|
||||||
|
return a + b;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { hello, Calculator };
|
||||||
|
')
|
||||||
|
f.flush()
|
||||||
|
file_path = Path(f.name)
|
||||||
|
analyzer = JavaScriptAnalyzer()
|
||||||
|
result = analyzer.analyze(file_path)
|
||||||
|
|
||||||
|
assert len(result["functions"]) >= 1
|
||||||
|
|
||||||
|
hello_func = next((f for f in result["functions"] if f.name == "hello"), None)
|
||||||
|
assert hello_func is not None
|
||||||
|
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
|
||||||
|
class TestGoAnalyzer:
|
||||||
|
"""Tests for GoAnalyzer."""
|
||||||
|
|
||||||
|
def test_can_analyze_go_file(self):
|
||||||
|
"""Test that analyzer recognizes Go files."""
|
||||||
|
analyzer = GoAnalyzer()
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".go", delete=False, mode="w") as f:
|
||||||
|
f.write("package main\n\nfunc hello() string { return 'hello' }")
|
||||||
|
f.flush()
|
||||||
|
assert analyzer.can_analyze(Path(f.name))
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_analyze_simple_function(self):
|
||||||
|
"""Test analyzing a simple Go function."""
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".go", delete=False, mode="w") as f:
|
||||||
|
f.write('package main
|
||||||
|
|
||||||
|
import "fmt"
|
||||||
|
|
||||||
|
func hello(name string) string {
|
||||||
|
return "Hello, " + name
|
||||||
|
}
|
||||||
|
|
||||||
|
type Calculator struct{}
|
||||||
|
|
||||||
|
func (c *Calculator) Add(a, b int) int {
|
||||||
|
return a + b
|
||||||
|
}
|
||||||
|
')
|
||||||
|
f.flush()
|
||||||
|
file_path = Path(f.name)
|
||||||
|
analyzer = GoAnalyzer()
|
||||||
|
result = analyzer.analyze(file_path)
|
||||||
|
|
||||||
|
hello_func = next((f for f in result["functions"] if f.name == "hello"), None)
|
||||||
|
assert hello_func is not None
|
||||||
|
assert hello_func.return_type is not None or "string" in str(hello_func.return_type)
|
||||||
|
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
|
||||||
|
class TestRustAnalyzer:
|
||||||
|
"""Tests for RustAnalyzer."""
|
||||||
|
|
||||||
|
def test_can_analyze_rs_file(self):
|
||||||
|
"""Test that analyzer recognizes Rust files."""
|
||||||
|
analyzer = RustAnalyzer()
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".rs", delete=False, mode="w") as f:
|
||||||
|
f.write("fn hello() -> String { String::from('hello') }")
|
||||||
|
f.flush()
|
||||||
|
assert analyzer.can_analyze(Path(f.name))
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
def test_analyze_simple_function(self):
|
||||||
|
"""Test analyzing a simple Rust function."""
|
||||||
|
with tempfile.NamedTemporaryFile(suffix=".rs", delete=False, mode="w") as f:
|
||||||
|
f.write('fn hello(name: &str) -> String {
|
||||||
|
format!("Hello, {}", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct Calculator;
|
||||||
|
|
||||||
|
impl Calculator {
|
||||||
|
pub fn add(a: i32, b: i32) -> i32 {
|
||||||
|
a + b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
')
|
||||||
|
f.flush()
|
||||||
|
file_path = Path(f.name)
|
||||||
|
analyzer = RustAnalyzer()
|
||||||
|
result = analyzer.analyze(file_path)
|
||||||
|
|
||||||
|
hello_func = next((f for f in result["functions"] if f.name == "hello"), None)
|
||||||
|
assert hello_func is not None
|
||||||
|
assert "name" in hello_func.parameters
|
||||||
|
assert hello_func.visibility == "private"
|
||||||
|
|
||||||
|
Path(f.name).unlink()
|
||||||
|
|
||||||
|
|
||||||
|
class TestCodeAnalyzerFactory:
|
||||||
|
"""Tests for CodeAnalyzerFactory."""
|
||||||
|
|
||||||
|
def test_get_analyzer_python(self):
|
||||||
|
"""Test getting analyzer for Python file."""
|
||||||
|
analyzer = CodeAnalyzerFactory.get_analyzer(Path("main.py"))
|
||||||
|
assert isinstance(analyzer, PythonAnalyzer)
|
||||||
|
|
||||||
|
def test_get_analyzer_js(self):
|
||||||
|
"""Test getting analyzer for JavaScript file."""
|
||||||
|
analyzer = CodeAnalyzerFactory.get_analyzer(Path("index.js"))
|
||||||
|
assert isinstance(analyzer, JavaScriptAnalyzer)
|
||||||
|
|
||||||
|
def test_get_analyzer_go(self):
|
||||||
|
"""Test getting analyzer for Go file."""
|
||||||
|
analyzer = CodeAnalyzerFactory.get_analyzer(Path("main.go"))
|
||||||
|
assert isinstance(analyzer, GoAnalyzer)
|
||||||
|
|
||||||
|
def test_get_analyzer_rust(self):
|
||||||
|
"""Test getting analyzer for Rust file."""
|
||||||
|
analyzer = CodeAnalyzerFactory.get_analyzer(Path("main.rs"))
|
||||||
|
assert isinstance(analyzer, RustAnalyzer)
|
||||||
|
|
||||||
|
def test_can_analyze(self):
|
||||||
|
"""Test can_analyze returns correct results."""
|
||||||
|
assert CodeAnalyzerFactory.can_analyze(Path("main.py"))
|
||||||
|
assert CodeAnalyzerFactory.can_analyze(Path("index.js"))
|
||||||
|
assert CodeAnalyzerFactory.can_analyze(Path("main.go"))
|
||||||
|
assert CodeAnalyzerFactory.can_analyze(Path("main.rs"))
|
||||||
|
assert not CodeAnalyzerFactory.can_analyze(Path("random.txt"))
|
||||||
@@ -3,12 +3,10 @@
|
|||||||
import os
|
import os
|
||||||
import tempfile
|
import tempfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import patch, MagicMock
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
from click.testing import CliRunner
|
from click.testing import CliRunner
|
||||||
|
|
||||||
from project_scaffold_cli.cli import main, _validate_project_name, _to_kebab_case
|
from project_scaffold_cli.cli import _to_kebab_case, _validate_project_name, main
|
||||||
|
|
||||||
|
|
||||||
class TestMain:
|
class TestMain:
|
||||||
|
|||||||
@@ -3,7 +3,6 @@
|
|||||||
import tempfile
|
import tempfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import pytest
|
|
||||||
import yaml
|
import yaml
|
||||||
|
|
||||||
from project_scaffold_cli.config import Config
|
from project_scaffold_cli.config import Config
|
||||||
|
|||||||
241
tests/test_parsers.py
Normal file
241
tests/test_parsers.py
Normal file
@@ -0,0 +1,241 @@
|
|||||||
|
"""Tests for dependency parsers."""
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from src.auto_readme.parsers import (
|
||||||
|
DependencyParserFactory,
|
||||||
|
GoDependencyParser,
|
||||||
|
JavaScriptDependencyParser,
|
||||||
|
PythonDependencyParser,
|
||||||
|
RustDependencyParser,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestPythonDependencyParser:
|
||||||
|
"""Tests for PythonDependencyParser."""
|
||||||
|
|
||||||
|
def test_can_parse_requirements_txt(self):
|
||||||
|
"""Test that parser recognizes requirements.txt."""
|
||||||
|
parser = PythonDependencyParser()
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
req_file = Path(tmp_dir) / "requirements.txt"
|
||||||
|
req_file.write_text("requests>=2.31.0\n")
|
||||||
|
assert parser.can_parse(req_file)
|
||||||
|
|
||||||
|
def test_can_parse_pyproject_toml(self):
|
||||||
|
"""Test that parser recognizes pyproject.toml."""
|
||||||
|
parser = PythonDependencyParser()
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
pyproject_file = Path(tmp_dir) / "pyproject.toml"
|
||||||
|
pyproject_file.write_text('[project]\ndependencies = ["requests>=2.0"]')
|
||||||
|
assert parser.can_parse(pyproject_file)
|
||||||
|
|
||||||
|
def test_parse_requirements_txt(self):
|
||||||
|
"""Test parsing requirements.txt file."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
req_file = Path(tmp_dir) / "requirements.txt"
|
||||||
|
req_file.write_text("""
|
||||||
|
requests>=2.31.0
|
||||||
|
click>=8.0.0
|
||||||
|
pytest==7.0.0
|
||||||
|
-e git+https://github.com/user/repo.git#egg=package
|
||||||
|
# This is a comment
|
||||||
|
numpy~=1.24.0
|
||||||
|
""")
|
||||||
|
|
||||||
|
parser = PythonDependencyParser()
|
||||||
|
deps = parser.parse(req_file)
|
||||||
|
|
||||||
|
assert len(deps) == 5
|
||||||
|
names = {d.name for d in deps}
|
||||||
|
assert "requests" in names
|
||||||
|
assert "click" in names
|
||||||
|
assert "pytest" in names
|
||||||
|
assert "numpy" in names
|
||||||
|
|
||||||
|
def test_parse_pyproject_toml(self):
|
||||||
|
"""Test parsing pyproject.toml file."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
pyproject_file = Path(tmp_dir) / "pyproject.toml"
|
||||||
|
pyproject_file.write_text("""
|
||||||
|
[project]
|
||||||
|
name = "test-project"
|
||||||
|
version = "0.1.0"
|
||||||
|
dependencies = [
|
||||||
|
"requests>=2.31.0",
|
||||||
|
"click>=8.0.0",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = ["pytest>=7.0.0", "black>=23.0.0"]
|
||||||
|
""")
|
||||||
|
|
||||||
|
parser = PythonDependencyParser()
|
||||||
|
deps = parser.parse(pyproject_file)
|
||||||
|
|
||||||
|
assert len(deps) == 4
|
||||||
|
|
||||||
|
|
||||||
|
class TestJavaScriptDependencyParser:
|
||||||
|
"""Tests for JavaScriptDependencyParser."""
|
||||||
|
|
||||||
|
def test_can_parse_package_json(self):
|
||||||
|
"""Test that parser recognizes package.json."""
|
||||||
|
parser = JavaScriptDependencyParser()
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
package_file = Path(tmp_dir) / "package.json"
|
||||||
|
package_file.write_text('{"name": "test"}')
|
||||||
|
assert parser.can_parse(package_file)
|
||||||
|
|
||||||
|
def test_parse_package_json(self):
|
||||||
|
"""Test parsing package.json file."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
package_file = Path(tmp_dir) / "package.json"
|
||||||
|
package_file.write_text("""
|
||||||
|
{
|
||||||
|
"name": "test-project",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"dependencies": {
|
||||||
|
"express": "^4.18.0",
|
||||||
|
"lodash": "~4.17.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"jest": "^29.0.0"
|
||||||
|
},
|
||||||
|
"optionalDependencies": {
|
||||||
|
"bcrypt": "^5.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""")
|
||||||
|
|
||||||
|
parser = JavaScriptDependencyParser()
|
||||||
|
deps = parser.parse(package_file)
|
||||||
|
|
||||||
|
assert len(deps) == 4
|
||||||
|
|
||||||
|
express = next((d for d in deps if d.name == "express"), None)
|
||||||
|
assert express is not None
|
||||||
|
assert express.version == "4.18.0"
|
||||||
|
assert not express.is_dev
|
||||||
|
|
||||||
|
jest = next((d for d in deps if d.name == "jest"), None)
|
||||||
|
assert jest is not None
|
||||||
|
assert jest.is_dev
|
||||||
|
|
||||||
|
bcrypt = next((d for d in deps if d.name == "bcrypt"), None)
|
||||||
|
assert bcrypt is not None
|
||||||
|
assert bcrypt.is_optional
|
||||||
|
|
||||||
|
|
||||||
|
class TestGoDependencyParser:
|
||||||
|
"""Tests for GoDependencyParser."""
|
||||||
|
|
||||||
|
def test_can_parse_go_mod(self):
|
||||||
|
"""Test that parser recognizes go.mod."""
|
||||||
|
parser = GoDependencyParser()
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
go_mod_file = Path(tmp_dir) / "go.mod"
|
||||||
|
go_mod_file.write_text("module test\n")
|
||||||
|
assert parser.can_parse(go_mod_file)
|
||||||
|
|
||||||
|
def test_parse_go_mod(self):
|
||||||
|
"""Test parsing go.mod file."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
go_mod_file = Path(tmp_dir) / "go.mod"
|
||||||
|
go_mod_file.write_text("""
|
||||||
|
module test-go-project
|
||||||
|
|
||||||
|
go 1.21
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/gin-gonic/gin v1.9.0
|
||||||
|
github.com/stretchr/testify v1.8.0
|
||||||
|
)
|
||||||
|
|
||||||
|
require github.com/user/repo v1.0.0
|
||||||
|
""")
|
||||||
|
|
||||||
|
parser = GoDependencyParser()
|
||||||
|
deps = parser.parse(go_mod_file)
|
||||||
|
|
||||||
|
assert len(deps) == 3
|
||||||
|
|
||||||
|
gin = next((d for d in deps if d.name == "github.com/gin-gonic/gin"), None)
|
||||||
|
assert gin is not None
|
||||||
|
assert gin.version is not None and "1.9.0" in gin.version
|
||||||
|
|
||||||
|
|
||||||
|
class TestRustDependencyParser:
|
||||||
|
"""Tests for RustDependencyParser."""
|
||||||
|
|
||||||
|
def test_can_parse_cargo_toml(self):
|
||||||
|
"""Test that parser recognizes Cargo.toml."""
|
||||||
|
parser = RustDependencyParser()
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
cargo_file = Path(tmp_dir) / "Cargo.toml"
|
||||||
|
cargo_file.write_text('[package]\nname = "test"')
|
||||||
|
assert parser.can_parse(cargo_file)
|
||||||
|
|
||||||
|
def test_parse_cargo_toml(self):
|
||||||
|
"""Test parsing Cargo.toml file."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
cargo_file = Path(tmp_dir) / "Cargo.toml"
|
||||||
|
cargo_file.write_text("""
|
||||||
|
[package]
|
||||||
|
name = "test-project"
|
||||||
|
version = "0.1.0"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
|
tokio = { version = "1.0", features = "full" }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
assertions = "0.1"
|
||||||
|
""")
|
||||||
|
|
||||||
|
parser = RustDependencyParser()
|
||||||
|
deps = parser.parse(cargo_file)
|
||||||
|
|
||||||
|
assert len(deps) == 3
|
||||||
|
|
||||||
|
serde = next((d for d in deps if d.name == "serde"), None)
|
||||||
|
assert serde is not None
|
||||||
|
assert serde.version is not None and "1.0" in serde.version
|
||||||
|
assert not serde.is_dev
|
||||||
|
|
||||||
|
assertions = next((d for d in deps if d.name == "assertions"), None)
|
||||||
|
assert assertions is not None
|
||||||
|
assert assertions.is_dev
|
||||||
|
|
||||||
|
|
||||||
|
class TestDependencyParserFactory:
|
||||||
|
"""Tests for DependencyParserFactory."""
|
||||||
|
|
||||||
|
def test_get_parser_python(self):
|
||||||
|
"""Test getting parser for Python file."""
|
||||||
|
parser = DependencyParserFactory.get_parser(Path("requirements.txt"))
|
||||||
|
assert isinstance(parser, PythonDependencyParser)
|
||||||
|
|
||||||
|
def test_get_parser_js(self):
|
||||||
|
"""Test getting parser for JavaScript file."""
|
||||||
|
parser = DependencyParserFactory.get_parser(Path("package.json"))
|
||||||
|
assert isinstance(parser, JavaScriptDependencyParser)
|
||||||
|
|
||||||
|
def test_get_parser_go(self):
|
||||||
|
"""Test getting parser for Go file."""
|
||||||
|
parser = DependencyParserFactory.get_parser(Path("go.mod"))
|
||||||
|
assert isinstance(parser, GoDependencyParser)
|
||||||
|
|
||||||
|
def test_get_parser_rust(self):
|
||||||
|
"""Test getting parser for Rust file."""
|
||||||
|
parser = DependencyParserFactory.get_parser(Path("Cargo.toml"))
|
||||||
|
assert isinstance(parser, RustDependencyParser)
|
||||||
|
|
||||||
|
def test_can_parse(self):
|
||||||
|
"""Test can_parse returns correct results."""
|
||||||
|
assert DependencyParserFactory.can_parse(Path("requirements.txt"))
|
||||||
|
assert DependencyParserFactory.can_parse(Path("package.json"))
|
||||||
|
assert DependencyParserFactory.can_parse(Path("go.mod"))
|
||||||
|
assert DependencyParserFactory.can_parse(Path("Cargo.toml"))
|
||||||
|
assert not DependencyParserFactory.can_parse(Path("random.txt"))
|
||||||
@@ -2,12 +2,10 @@
|
|||||||
|
|
||||||
import tempfile
|
import tempfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import MagicMock, patch
|
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from project_scaffold_cli.template_engine import TemplateEngine
|
from project_scaffold_cli.template_engine import TemplateEngine
|
||||||
from project_scaffold_cli.config import Config
|
|
||||||
|
|
||||||
|
|
||||||
class TestTemplateEngine:
|
class TestTemplateEngine:
|
||||||
|
|||||||
131
tests/test_utils.py
Normal file
131
tests/test_utils.py
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
"""Tests for utility modules."""
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from src.auto_readme.utils.file_scanner import FileScanner
|
||||||
|
from src.auto_readme.utils.path_utils import PathUtils
|
||||||
|
|
||||||
|
|
||||||
|
class TestPathUtils:
|
||||||
|
"""Tests for PathUtils."""
|
||||||
|
|
||||||
|
def test_normalize_path(self):
|
||||||
|
"""Test path normalization."""
|
||||||
|
path = PathUtils.normalize_path("./foo/bar")
|
||||||
|
assert path.is_absolute()
|
||||||
|
|
||||||
|
def test_is_ignored_dir(self):
|
||||||
|
"""Test ignored directory detection."""
|
||||||
|
assert PathUtils.is_ignored_dir(Path("__pycache__"))
|
||||||
|
assert PathUtils.is_ignored_dir(Path(".git"))
|
||||||
|
assert PathUtils.is_ignored_dir(Path("node_modules"))
|
||||||
|
assert not PathUtils.is_ignored_dir(Path("src"))
|
||||||
|
|
||||||
|
def test_is_ignored_file(self):
|
||||||
|
"""Test ignored file detection."""
|
||||||
|
assert PathUtils.is_ignored_file(Path(".gitignore"))
|
||||||
|
assert not PathUtils.is_ignored_file(Path("main.py"))
|
||||||
|
|
||||||
|
def test_is_source_file(self):
|
||||||
|
"""Test source file detection."""
|
||||||
|
assert PathUtils.is_source_file(Path("main.py"))
|
||||||
|
assert PathUtils.is_source_file(Path("index.js"))
|
||||||
|
assert PathUtils.is_source_file(Path("main.go"))
|
||||||
|
assert PathUtils.is_source_file(Path("lib.rs"))
|
||||||
|
assert not PathUtils.is_source_file(Path("README.md"))
|
||||||
|
|
||||||
|
def test_is_config_file(self):
|
||||||
|
"""Test config file detection."""
|
||||||
|
assert PathUtils.is_config_file(Path("config.json"))
|
||||||
|
assert PathUtils.is_config_file(Path("settings.yaml"))
|
||||||
|
assert PathUtils.is_config_file(Path("pyproject.toml"))
|
||||||
|
|
||||||
|
def test_is_test_file(self):
|
||||||
|
"""Test test file detection."""
|
||||||
|
assert PathUtils.is_test_file(Path("test_main.py"))
|
||||||
|
assert PathUtils.is_test_file(Path("tests/utils.py"))
|
||||||
|
assert PathUtils.is_test_file(Path("example.test.js"))
|
||||||
|
assert not PathUtils.is_test_file(Path("main.py"))
|
||||||
|
|
||||||
|
def test_is_hidden(self):
|
||||||
|
"""Test hidden file detection."""
|
||||||
|
assert PathUtils.is_hidden(Path(".gitignore"))
|
||||||
|
assert not PathUtils.is_hidden(Path("main.py"))
|
||||||
|
|
||||||
|
def test_detect_project_root(self):
|
||||||
|
"""Test project root detection."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
|
root = Path(tmp_dir)
|
||||||
|
subdir = root / "src" / "package"
|
||||||
|
subdir.mkdir(parents=True)
|
||||||
|
|
||||||
|
(root / "pyproject.toml").touch()
|
||||||
|
|
||||||
|
detected = PathUtils.detect_project_root(subdir)
|
||||||
|
assert detected == root
|
||||||
|
|
||||||
|
def test_get_relative_path(self):
|
||||||
|
"""Test relative path calculation."""
|
||||||
|
base = Path("/home/user/project")
|
||||||
|
target = Path("/home/user/project/src/main.py")
|
||||||
|
relative = PathUtils.get_relative_path(target, base)
|
||||||
|
assert relative == Path("src/main.py")
|
||||||
|
|
||||||
|
|
||||||
|
class TestFileScanner:
|
||||||
|
"""Tests for FileScanner."""
|
||||||
|
|
||||||
|
def test_scan_python_project(self, create_python_project):
|
||||||
|
"""Test scanning a Python project."""
|
||||||
|
scanner = FileScanner(create_python_project)
|
||||||
|
files = scanner.scan_and_create()
|
||||||
|
|
||||||
|
file_names = {f.path.name for f in files}
|
||||||
|
assert "main.py" in file_names
|
||||||
|
assert "__init__.py" in file_names
|
||||||
|
assert "requirements.txt" in file_names
|
||||||
|
assert "pyproject.toml" in file_names
|
||||||
|
|
||||||
|
def test_detect_project_type_python(self, create_python_project):
|
||||||
|
"""Test project type detection for Python."""
|
||||||
|
from src.auto_readme.models import ProjectType
|
||||||
|
|
||||||
|
scanner = FileScanner(create_python_project)
|
||||||
|
project_type = scanner.detect_project_type()
|
||||||
|
|
||||||
|
assert project_type == ProjectType.PYTHON
|
||||||
|
|
||||||
|
def test_detect_project_type_javascript(self, create_javascript_project):
|
||||||
|
"""Test project type detection for JavaScript."""
|
||||||
|
from src.auto_readme.models import ProjectType
|
||||||
|
|
||||||
|
scanner = FileScanner(create_javascript_project)
|
||||||
|
project_type = scanner.detect_project_type()
|
||||||
|
|
||||||
|
assert project_type == ProjectType.JAVASCRIPT
|
||||||
|
|
||||||
|
def test_detect_project_type_go(self, create_go_project):
|
||||||
|
"""Test project type detection for Go."""
|
||||||
|
from src.auto_readme.models import ProjectType
|
||||||
|
|
||||||
|
scanner = FileScanner(create_go_project)
|
||||||
|
project_type = scanner.detect_project_type()
|
||||||
|
|
||||||
|
assert project_type == ProjectType.GO
|
||||||
|
|
||||||
|
def test_detect_project_type_rust(self, create_rust_project):
|
||||||
|
"""Test project type detection for Rust."""
|
||||||
|
from src.auto_readme.models import ProjectType
|
||||||
|
|
||||||
|
scanner = FileScanner(create_rust_project)
|
||||||
|
project_type = scanner.detect_project_type()
|
||||||
|
|
||||||
|
assert project_type == ProjectType.RUST
|
||||||
|
|
||||||
|
def test_scan_mixed_project(self, create_mixed_project):
|
||||||
|
"""Test scanning a project with multiple languages."""
|
||||||
|
scanner = FileScanner(create_mixed_project)
|
||||||
|
files = scanner.scan_and_create()
|
||||||
|
|
||||||
|
assert len(files) > 0
|
||||||
Reference in New Issue
Block a user