Skip to content

Commit

Permalink
manually fixed cicd
Browse files Browse the repository at this point in the history
  • Loading branch information
rdmueller committed Dec 21, 2024
1 parent 4b5a745 commit cecee6e
Show file tree
Hide file tree
Showing 8 changed files with 1,173 additions and 117 deletions.
84 changes: 0 additions & 84 deletions .github/workflows/ci.yml

This file was deleted.

1 change: 0 additions & 1 deletion .github/workflows/ci.yml.meta

This file was deleted.

9 changes: 0 additions & 9 deletions .github/workflows/run-tests.yml

This file was deleted.

10 changes: 10 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# This configuration file was automatically generated by Gitpod.
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
# and commit this file to your remote git repository to share the goodness with others.

# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart

tasks:
- init: pip install .


84 changes: 63 additions & 21 deletions asciidoc_linter.egg-info/PKG-INFO
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Requires-Dist: coverage>=7.0.0; extra == "test"
Requires-Dist: pytest-html>=4.1.1; extra == "test"
Requires-Dist: pytest-metadata>=3.1.1; extra == "test"

// README.adoc - Project documentation
# README.adoc - Project documentation
= AsciiDoc Linter
:toc: left
:icons: font
Expand All @@ -35,6 +35,8 @@ Requires-Dist: pytest-metadata>=3.1.1; extra == "test"

image:https://img.shields.io/badge/license-MIT-blue.svg[License: MIT, link=https://opensource.org/licenses/MIT]
image:https://img.shields.io/badge/python-3.8+-blue.svg[Python Version]
image:https://img.shields.io/badge/test--coverage-95%25-green.svg[Test Coverage]
image:https://img.shields.io/badge/tests-97%25-green.svg[Test Success Rate]

A Python-based linter for AsciiDoc files that helps maintain consistent documentation quality and style. Part of the docToolchain project.

Expand All @@ -51,42 +53,54 @@ This project is part of docToolchain (https://doctoolchain.org), a collection of

=== Implemented Rules

[cols="1,2,1"]
[cols="1,2,1,1"]
|===
|Rule ID |Description |Severity
|Rule ID |Description |Severity |Status

|HEAD001
|Check for proper heading hierarchy (no skipping levels)
|ERROR
|✅ Stable

|HEAD002
|Verify heading format (spacing and capitalization)
|ERROR/WARNING
|✅ Stable

|HEAD003
|Detect multiple top-level headers
|ERROR
|✅ Stable

|BLOCK001
|Check for unterminated blocks (listing, example, sidebar, etc.)
|ERROR
|✅ Stable

|BLOCK002
|Verify proper spacing around blocks
|WARNING
|✅ Stable

|WS001
|Check whitespace usage (blank lines, list markers, tabs)
|WARNING
|✅ Stable

|IMG001
|Verify image attributes and file references
|WARNING/ERROR
|✅ Stable

|TABLE001
|Table formatting consistency
|WARNING/ERROR
|⚠️ Beta
|===

=== Planned Rules

* TABLE001: Table formatting consistency
* TABLE002: Table content validation
* LINK001: Broken internal references
* FMT001: Markdown-compatible styles detection

Expand Down Expand Up @@ -155,6 +169,15 @@ WARNING: Missing alt text for image: diagram.png (line 80)

== Development

=== Current Status

* Test Coverage: 95%
* Test Success Rate: 97.3% (107/110 tests passing)
* Known Issues:
** Table content validation needs improvement
** Rules.py requires test coverage
** Reporter module needs additional tests

=== Running Tests

[source,bash]
Expand All @@ -164,6 +187,9 @@ python run_tests.py

# Run specific test file
python -m unittest tests/rules/test_heading_rules.py

# Run tests with coverage
python run_tests_html.py
----

=== Project Structure
Expand All @@ -174,24 +200,36 @@ asciidoc-linter/
├── asciidoc_linter/
│ ├── __init__.py
│ ├── cli.py
│ ├── rules/
│ │ ├── __init__.py
│ │ ├── base.py
│ │ ├── heading_rules.py
│ │ ├── block_rules.py
│ │ ├── whitespace_rules.py
│ │ └── image_rules.py
│ ├── linter.py
│ ├── parser.py
│ └── reporter.py
│ ├── reporter.py
│ └── rules/
│ ├── __init__.py
│ ├── base.py
│ ├── base_rules.py
│ ├── block_rules.py
│ ├── heading_rules.py
│ ├── image_rules.py
│ ├── table_rules.py
│ └── whitespace_rules.py
├── tests/
│ ├── __init__.py
│ ├── test_base.py
│ ├── test_cli.py
│ ├── test_linter.py
│ ├── test_reporter.py
│ └── rules/
│ ├── test_heading_rules.py
│ ├── test_block_rules.py
│ ├── test_whitespace_rules.py
│ └── test_image_rules.py
│ ├── test_heading_rules.py
│ ├── test_image_rules.py
│ ├── test_table_rules.py
│ └── test_whitespace_rules.py
├── docs/
│ ├── arc42/
│ ├── manual/
│ ├── test-results/
│ ├── requirements.adoc
│ └── block_rules.adoc
│ └── implementation_plan.adoc
├── README.adoc
└── run_tests.py
----
Expand All @@ -206,6 +244,7 @@ Contributions are welcome! Please feel free to submit a Pull Request. For major
2. Update documentation
3. Follow Python code style guidelines
4. Add appropriate error messages and context
5. Ensure test coverage remains above 90%

== License

Expand All @@ -224,17 +263,20 @@ This project is licensed under the MIT License - see the LICENSE file for detail
* ✅ Block structure rules
* ✅ Whitespace rules
* ✅ Image validation
* ⚠️ Table validation
* ⏳ Configuration system

2. Phase 2
* 🔲 Table validation
* 🔲 Link checking
* 🔲 Format rules
2. Phase 2 (Next)
* 🔲 Fix table content validation
* 🔲 Improve test coverage
* 🔲 Add link checking
* 🔲 Add format rules

3. Phase 3
3. Phase 3 (Future)
* 🔲 IDE integration
* 🔲 Git pre-commit hooks
* 🔲 Custom rule development
* 🔲 Performance optimization

== Contact

Expand Down
9 changes: 8 additions & 1 deletion asciidoc_linter.egg-info/SOURCES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ run_tests.py.meta
setup.py
setup.py.meta
.github/workflows/gh-pages.yml
.github/workflows/run-tests.yml
asciidoc_linter/.meta
asciidoc_linter/__init__.py
asciidoc_linter/__init__.py.meta
Expand Down Expand Up @@ -39,6 +38,7 @@ asciidoc_linter/rules/base.py.meta
asciidoc_linter/rules/base_rules.py
asciidoc_linter/rules/base_rules.py.meta
asciidoc_linter/rules/block_rules.py
asciidoc_linter/rules/concrete_rules.py
asciidoc_linter/rules/heading_rules.py
asciidoc_linter/rules/heading_rules.py.meta
asciidoc_linter/rules/image_rules.py
Expand Down Expand Up @@ -96,8 +96,15 @@ tests/__init__.py
tests/__init__.py.meta
tests/test.adoc
tests/test.adoc.meta
tests/test_base.py
tests/test_base_rules.py
tests/test_cli.py
tests/test_linter.py
tests/test_reporter.py
tests/test_rule_registry.py
tests/test_rules.py
tests/test_rules_imports.py
tests/test_table_rules.py
tests/rules/.meta
tests/rules/__init__.py
tests/rules/__init__.py.meta
Expand Down
Loading

0 comments on commit cecee6e

Please sign in to comment.