diff --git a/.dprint.jsonc b/.dprint.jsonc new file mode 100644 index 0000000..57b4810 --- /dev/null +++ b/.dprint.jsonc @@ -0,0 +1,42 @@ +{ + "typescript": { + }, + "json": { + }, + "markdown": { + }, + "toml": { + }, + "dockerfile": { + }, + "oxc": { + }, + "ruff": { + }, + "jupyter": { + }, + "malva": { + }, + "markup": { + }, + "yaml": { + }, + "excludes": [ + "**/node_modules", + "**/*-lock.json", + ], + "plugins": [ + "https://plugins.dprint.dev/typescript-0.95.13.wasm", + "https://plugins.dprint.dev/json-0.21.1.wasm", + "https://plugins.dprint.dev/markdown-0.20.0.wasm", + "https://plugins.dprint.dev/toml-0.7.0.wasm", + "https://plugins.dprint.dev/dockerfile-0.3.3.wasm", + "https://plugins.dprint.dev/oxc-0.1.0.wasm", + "https://plugins.dprint.dev/ruff-0.6.11.wasm", + "https://plugins.dprint.dev/jupyter-0.2.1.wasm", + "https://plugins.dprint.dev/g-plane/malva-v0.15.1.wasm", + "https://plugins.dprint.dev/g-plane/markup_fmt-v0.25.3.wasm", + "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm", + "https://plugins.dprint.dev/exec-0.6.0.json@a054130d458f124f9b5c91484833828950723a5af3f8ff2bd1523bd47b83b364", + ], +} diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 52f5664..48ee87e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,5 +1,5 @@ # These owners will be the default owners for everything in -# the repo. Unless a later match takes precedence, they will +# the repo. Unless a later match takes precedence, they will # be requested for review when someone opens a pull request. * @kjanat diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index ccb9e57..5ce0145 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -- Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -- The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -- Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3b4e6ae..049355e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,73 +12,73 @@ This project and everyone participating in it is governed by our Code of Conduct Before creating bug reports, please check existing issues as you might find that the issue has already been reported. When creating a bug report, include as many details as possible: -- Use the bug report template -- Include sample Articulate Rise content that reproduces the issue -- Provide your environment details (OS, Go version, etc.) -- Include error messages and stack traces +- Use the bug report template +- Include sample Articulate Rise content that reproduces the issue +- Provide your environment details (OS, Go version, etc.) +- Include error messages and stack traces ### Suggesting Enhancements Enhancement suggestions are welcome! Please use the feature request template and include: -- A clear description of the enhancement -- Your use case and why this would be valuable -- Any implementation ideas you might have +- A clear description of the enhancement +- Your use case and why this would be valuable +- Any implementation ideas you might have ### Pull Requests -1. **Fork the repository** and create your branch from `master` -2. **Make your changes** following our coding standards -3. **Add tests** for any new functionality -4. **Ensure all tests pass** by running `go test ./...` -5. **Run `go fmt`** to format your code -6. **Run `go vet`** to check for common issues -7. **Update documentation** if needed -8. **Create a pull request** with a clear title and description +1. **Fork the repository** and create your branch from `master` +2. **Make your changes** following our coding standards +3. **Add tests** for any new functionality +4. **Ensure all tests pass** by running `go test ./...` +5. **Run `go fmt`** to format your code +6. **Run `go vet`** to check for common issues +7. **Update documentation** if needed +8. **Create a pull request** with a clear title and description ## Development Setup -1. **Prerequisites:** +1. **Prerequisites:** -- Go 1.21 or later -- Git +- Go 1.21 or later +- Git -2. **Clone and setup:** +2. **Clone and setup:** - ```bash - git clone https://github.com/your-username/articulate-parser.git - cd articulate-parser - go mod download - ``` +```bash +git clone https://github.com/your-username/articulate-parser.git +cd articulate-parser +go mod download +``` -3. **Run tests:** +3. **Run tests:** - ```bash - go test -v ./... - ``` +```bash +go test -v ./... +``` -4. **Build:** +4. **Build:** - ```bash - go build main.go - ``` +```bash +go build main.go +``` ## Coding Standards ### Go Style Guide -- Follow the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) -- Use `gofmt` to format your code -- Use meaningful variable and function names -- Add comments for exported functions and types -- Keep functions focused and small +- Follow the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) +- Use `gofmt` to format your code +- Use meaningful variable and function names +- Add comments for exported functions and types +- Keep functions focused and small ### Testing -- Write tests for new functionality -- Use table-driven tests where appropriate -- Aim for good test coverage -- Test error cases and edge conditions +- Write tests for new functionality +- Use table-driven tests where appropriate +- Aim for good test coverage +- Test error cases and edge conditions ### Commit Messages @@ -112,19 +112,19 @@ articulate-parser/ ### New Content Types -1. Add the content type definition to `types/` -2. Implement parsing logic in `parser/` -3. Add export handling in `exporters/` -4. Write comprehensive tests -5. Update documentation +1. Add the content type definition to `types/` +2. Implement parsing logic in `parser/` +3. Add export handling in `exporters/` +4. Write comprehensive tests +5. Update documentation ### New Export Formats -1. Create a new exporter in `exporters/` -2. Implement the `Exporter` interface -3. Add CLI support in `main.go` -4. Add tests with sample output -5. Update README with usage examples +1. Create a new exporter in `exporters/` +2. Implement the `Exporter` interface +3. Add CLI support in `main.go` +4. Add tests with sample output +5. Update README with usage examples ## Testing @@ -146,31 +146,31 @@ go test -run TestSpecificFunction ./... ### Test Data -- Add sample Articulate Rise JSON files to `tests/data/` -- Include both simple and complex content examples -- Test edge cases and error conditions +- Add sample Articulate Rise JSON files to `tests/data/` +- Include both simple and complex content examples +- Test edge cases and error conditions ## Documentation -- Update the README for user-facing changes -- Add inline code comments for complex logic -- Update examples when adding new features -- Keep the feature list current +- Update the README for user-facing changes +- Add inline code comments for complex logic +- Update examples when adding new features +- Keep the feature list current ## Release Process Releases are handled by maintainers: -1. Version bumping follows semantic versioning -2. Releases are created from the `master` branch -3. GitHub Actions automatically builds and publishes releases -4. Release notes are auto-generated from commits +1. Version bumping follows semantic versioning +2. Releases are created from the `master` branch +3. GitHub Actions automatically builds and publishes releases +4. Release notes are auto-generated from commits ## Questions? -- Open a discussion for general questions -- Use the question issue template for specific help -- Check existing issues and documentation first +- Open a discussion for general questions +- Use the question issue template for specific help +- Check existing issues and documentation first ## Recognition diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5f760ab..b04a947 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,7 +1,7 @@ name: Bug Report description: Create a report to help us improve -title: '[BUG] ' -labels: ['bug', 'triage'] +title: "[BUG] " +labels: ["bug", "triage"] body: - type: markdown attributes: @@ -27,9 +27,9 @@ body: 2. Parse file '...' 3. See error value: | - 1. - 2. - 3. + 1. + 2. + 3. validations: required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b6da683..43330ca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,31 +5,34 @@ ## Related Issue + Fixes # ## Type of Change -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Documentation update -- [ ] Performance improvement -- [ ] Code refactoring (no functional changes) -- [ ] Test updates + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Performance improvement +- [ ] Code refactoring (no functional changes) +- [ ] Test updates ## Checklist -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my code -- [ ] I have added comments to complex logic -- [ ] I have updated the documentation -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] I have checked for potential breaking changes -- [ ] No new warnings are generated -- [ ] The commit message follows our guidelines + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have added comments to complex logic +- [ ] I have updated the documentation +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] I have checked for potential breaking changes +- [ ] No new warnings are generated +- [ ] The commit message follows our guidelines ## Screenshots (if appropriate) @@ -42,6 +45,7 @@ Fixes # ## Testing Instructions + 1. 2. 3. diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 5b7d306..50d2e83 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -13,32 +13,32 @@ Currently, the following versions of Articulate Rise Parser are supported with s We take the security of Articulate Rise Parser seriously. If you believe you have found a security vulnerability, please follow these steps: -1. **Do not disclose the vulnerability publicly** - Please do not create a public GitHub issue for security vulnerabilities. -2. **Email the details to [security+articulate-parser@kjanat.com]** - Include as much information as possible about the vulnerability. -3. **Wait for a response** - We will acknowledge your email within 48 hours and provide an estimated timeline for a fix. -4. **Work with us** - We may ask for additional information to help us understand and address the issue. +1. **Do not disclose the vulnerability publicly** - Please do not create a public GitHub issue for security vulnerabilities. +2. **Email the details to [security+articulate-parser@kjanat.com]** - Include as much information as possible about the vulnerability. +3. **Wait for a response** - We will acknowledge your email within 48 hours and provide an estimated timeline for a fix. +4. **Work with us** - We may ask for additional information to help us understand and address the issue. ## What to Include in a Report When reporting a vulnerability, please include: -- A clear description of the issue -- Steps to reproduce the vulnerability -- The potential impact of the vulnerability -- Any possible mitigations you've identified +- A clear description of the issue +- Steps to reproduce the vulnerability +- The potential impact of the vulnerability +- Any possible mitigations you've identified ## What to Expect -- We will acknowledge receipt of your vulnerability report within 48 hours. -- We will provide regular updates about our progress. -- We will notify you when the vulnerability is fixed. -- With your permission, we will include your name in the acknowledgments. +- We will acknowledge receipt of your vulnerability report within 48 hours. +- We will provide regular updates about our progress. +- We will notify you when the vulnerability is fixed. +- With your permission, we will include your name in the acknowledgments. ## Security Measures This project follows these security practices: -- Regular dependency updates via Dependabot -- CodeQL security scanning -- Automated testing for each pull request -- Code review requirements for all changes +- Regular dependency updates via Dependabot +- CodeQL security scanning +- Automated testing for each pull request +- Code review requirements for all changes diff --git a/.github/dependabot.yml b/.github/dependabot.yml index dc0d74f..6a2d5c2 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,86 +1,86 @@ version: 2 updates: # Check for updates to GitHub Actions - - package-ecosystem: 'github-actions' - directory: '/' + - package-ecosystem: "github-actions" + directory: "/" schedule: - interval: 'weekly' - day: 'monday' - time: '07:00' - timezone: 'Europe/Amsterdam' + interval: "weekly" + day: "monday" + time: "07:00" + timezone: "Europe/Amsterdam" open-pull-requests-limit: 2 labels: - - 'dependencies' - - 'dependencies/github-actions' + - "dependencies" + - "dependencies/github-actions" commit-message: - prefix: 'ci' - include: 'scope' + prefix: "ci" + include: "scope" # Check for updates to Docker - - package-ecosystem: 'docker' - directory: '/' + - package-ecosystem: "docker" + directory: "/" schedule: - interval: 'weekly' - day: 'monday' - time: '07:00' - timezone: 'Europe/Amsterdam' + interval: "weekly" + day: "monday" + time: "07:00" + timezone: "Europe/Amsterdam" open-pull-requests-limit: 2 labels: - - 'dependencies' - - 'dependencies/docker' + - "dependencies" + - "dependencies/docker" commit-message: - prefix: 'docker' - include: 'scope' + prefix: "docker" + include: "scope" groups: docker: patterns: - - '*' + - "*" update-types: - - 'minor' - - 'patch' + - "minor" + - "patch" # Check for updates to Docker Compose - - package-ecosystem: 'docker-compose' - directory: '/' + - package-ecosystem: "docker-compose" + directory: "/" schedule: - interval: 'weekly' - day: 'monday' - time: '07:00' - timezone: 'Europe/Amsterdam' + interval: "weekly" + day: "monday" + time: "07:00" + timezone: "Europe/Amsterdam" open-pull-requests-limit: 2 labels: - - 'dependencies' - - 'dependencies/docker-compose' + - "dependencies" + - "dependencies/docker-compose" commit-message: - prefix: 'docker' - include: 'scope' + prefix: "docker" + include: "scope" groups: docker: patterns: - - '*' + - "*" update-types: - - 'minor' - - 'patch' + - "minor" + - "patch" # Check for updates to Go modules - - package-ecosystem: 'gomod' - directory: '/' + - package-ecosystem: "gomod" + directory: "/" schedule: - interval: 'weekly' - day: 'monday' - time: '07:00' - timezone: 'Europe/Amsterdam' + interval: "weekly" + day: "monday" + time: "07:00" + timezone: "Europe/Amsterdam" open-pull-requests-limit: 2 labels: - - 'dependencies' - - 'dependencies/go' + - "dependencies" + - "dependencies/go" commit-message: - prefix: 'deps' - include: 'scope' + prefix: "deps" + include: "scope" groups: go-modules: patterns: - - '*' + - "*" update-types: - - 'minor' - - 'patch' + - "minor" + - "patch" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 052f0c9..2482750 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -64,6 +64,8 @@ jobs: - name: Run tests with enhanced reporting id: test + env: + CGO_ENABLED: 1 run: | cat >> $GITHUB_STEP_SUMMARY << EOF ## 🔧 Test Environment @@ -354,7 +356,7 @@ jobs: permissions: contents: read packages: write - needs: [test, docker-test, dependency-review] + needs: [test, docker-test] if: | github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop' || diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index a9a85a4..60b4101 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -1,104 +1,104 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -# -# ******** NOTE ******** -# We have attempted to detect the languages in your repository. Please check -# the `language` matrix defined below to confirm you have the correct set of -# supported CodeQL languages. -# -name: "CodeQL" - -# This workflow is configured to be called by other workflows for more controlled execution -# This allows integration with the main CI pipeline and avoids redundant runs -# To enable automatic execution, uncomment the triggers below: -on: - workflow_call: - schedule: - - cron: '44 16 * * 6' - # push: - # branches: [ "master" ] - # pull_request: - # branches: [ "master" ] - -jobs: - analyze: - name: Analyze (${{ matrix.language }}) - # Runner size impacts CodeQL analysis time. To learn more, please see: - # - https://gh.io/recommended-hardware-resources-for-running-codeql - # - https://gh.io/supported-runners-and-hardware-resources - # - https://gh.io/using-larger-runners (GitHub.com only) - # Consider using larger runners or machines with greater resources for possible analysis time improvements. - runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} - permissions: - # required for all workflows - security-events: write - - # required to fetch internal or private CodeQL packs - packages: read - - # only required for workflows in private repositories - actions: read - contents: read - - strategy: - fail-fast: false - matrix: - include: - - language: actions - build-mode: none - - language: go - build-mode: autobuild - # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' - # Use `c-cpp` to analyze code written in C, C++ or both - # Use 'java-kotlin' to analyze code written in Java, Kotlin or both - # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both - # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, - # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. - # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how - # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages - steps: - - name: Checkout repository - uses: actions/checkout@v6 - - # Add any setup steps before running the `github/codeql-action/init` action. - # This includes steps like installing compilers or runtimes (`actions/setup-node` - # or others). This is typically only required for manual builds. - # - name: Setup runtime (example) - # uses: actions/setup-example@v1 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v4 - with: - languages: ${{ matrix.language }} - build-mode: ${{ matrix.build-mode }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - - # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality - - # If the analyze step fails for one of the languages you are analyzing with - # "We were unable to automatically build your code", modify the matrix above - # to set the build mode to "manual" for that language. Then modify this step - # to build your code. - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - - if: matrix.build-mode == 'manual' - shell: bash - run: | - echo 'If you are using a "manual" build mode for one or more of the' \ - 'languages you are analyzing, replace this with the commands to build' \ - 'your code, for example:' - echo ' make bootstrap' - echo ' make release' - exit 1 - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v4 - with: - category: "/language:${{matrix.language}}" +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +# This workflow is configured to be called by other workflows for more controlled execution +# This allows integration with the main CI pipeline and avoids redundant runs +# To enable automatic execution, uncomment the triggers below: +on: + workflow_call: + schedule: + - cron: "44 16 * * 6" + # push: + # branches: [ "master" ] + # pull_request: + # branches: [ "master" ] + +jobs: + analyze: + name: Analyze (${{ matrix.language }}) + # Runner size impacts CodeQL analysis time. To learn more, please see: + # - https://gh.io/recommended-hardware-resources-for-running-codeql + # - https://gh.io/supported-runners-and-hardware-resources + # - https://gh.io/using-larger-runners (GitHub.com only) + # Consider using larger runners or machines with greater resources for possible analysis time improvements. + runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} + permissions: + # required for all workflows + security-events: write + + # required to fetch internal or private CodeQL packs + packages: read + + # only required for workflows in private repositories + actions: read + contents: read + + strategy: + fail-fast: false + matrix: + include: + - language: actions + build-mode: none + - language: go + build-mode: autobuild + # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' + # Use `c-cpp` to analyze code written in C, C++ or both + # Use 'java-kotlin' to analyze code written in Java, Kotlin or both + # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both + # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, + # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. + # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how + # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages + steps: + - name: Checkout repository + uses: actions/checkout@v6 + + # Add any setup steps before running the `github/codeql-action/init` action. + # This includes steps like installing compilers or runtimes (`actions/setup-node` + # or others). This is typically only required for manual builds. + # - name: Setup runtime (example) + # uses: actions/setup-example@v1 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v4 + with: + languages: ${{ matrix.language }} + build-mode: ${{ matrix.build-mode }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + # If the analyze step fails for one of the languages you are analyzing with + # "We were unable to automatically build your code", modify the matrix above + # to set the build mode to "manual" for that language. Then modify this step + # to build your code. + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + - if: matrix.build-mode == 'manual' + shell: bash + run: | + echo 'If you are using a "manual" build mode for one or more of the' \ + 'languages you are analyzing, replace this with the commands to build' \ + 'your code, for example:' + echo ' make bootstrap' + echo ' make release' + exit 1 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v4 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index ca1a6f8..241a21a 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -16,10 +16,10 @@ jobs: dependency-review: runs-on: ubuntu-latest steps: - - name: 'Checkout Repository' + - name: "Checkout Repository" uses: actions/checkout@v6 - - name: 'Dependency Review' + - name: "Dependency Review" uses: actions/dependency-review-action@v4 with: fail-on-severity: moderate diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 98e2bb7..e8a89e7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: docker: name: Docker Build & Push runs-on: ubuntu-latest - needs: ['release'] + needs: ["release"] permissions: contents: read packages: write diff --git a/.gitignore b/.gitignore index 0627806..fd64c00 100644 --- a/.gitignore +++ b/.gitignore @@ -1,79 +1,79 @@ -# Created by https://www.toptal.com/developers/gitignore/api/go -# Edit at https://www.toptal.com/developers/gitignore?templates=go - -### Go ### -# If you prefer the allow list template instead of the deny list, see community template: -# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore -# -# Binaries for programs and plugins -*.exe -*.exe~ -*.dll -*.so -*.dylib - -# Test binary, built with `go test -c` -*.test - -# Output of the go coverage tool, specifically when used with LiteIDE -*.out - -# Dependency directories (remove the comment below to include it) -# vendor/ - -# Go workspace file -go.work - -# End of https://www.toptal.com/developers/gitignore/api/go - -# Shit -.github/TODO - -# Local test files -output/ -outputs/ -articulate-sample.json -test-output.* -go-os-arch-matrix.csv -test_godocx.go -test_input.json - -# Build artifacts -build/ - -# Old workflows -.github/workflows/ci-old.yml -.github/workflows/ci-enhanced.yml - -# Test coverage files -coverage.out -coverage.txt -coverage.html -coverage.* -coverage -*.cover -*.coverprofile -main_coverage - -# Other common exclusions -*.exe -*.exe~ -*.dll -*.so -*.dylib -*.test -*.out -/tmp/ -.github/copilot-instructions.md - -# Editors -.vscode/ -.idea/ - -.task/ - -**/*.local.* - -.claude/ - -NUL +# Created by https://www.toptal.com/developers/gitignore/api/go +# Edit at https://www.toptal.com/developers/gitignore?templates=go + +### Go ### +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work + +# End of https://www.toptal.com/developers/gitignore/api/go + +# Shit +.github/TODO + +# Local test files +output/ +outputs/ +articulate-sample.json +test-output.* +go-os-arch-matrix.csv +test_godocx.go +test_input.json + +# Build artifacts +build/ + +# Old workflows +.github/workflows/ci-old.yml +.github/workflows/ci-enhanced.yml + +# Test coverage files +coverage.out +coverage.txt +coverage.html +coverage.* +coverage +*.cover +*.coverprofile +main_coverage + +# Other common exclusions +*.exe +*.exe~ +*.dll +*.so +*.dylib +*.test +*.out +/tmp/ +.github/copilot-instructions.md + +# Editors +.vscode/ +.idea/ + +.task/ + +**/*.local.* + +.claude/ + +NUL diff --git a/.golangci.yml b/.golangci.yml index c5be94d..a81c519 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -79,68 +79,68 @@ linters: # Enable specific linters enable: # Default/standard linters - - errcheck # Check for unchecked errors - - govet # Go vet - - ineffassign # Detect ineffectual assignments - - staticcheck # Staticcheck - - unused # Find unused code + - errcheck # Check for unchecked errors + - govet # Go vet + - ineffassign # Detect ineffectual assignments + - staticcheck # Staticcheck + - unused # Find unused code # Code quality - - revive # Fast, configurable linter - - gocritic # Opinionated Go source code linter - - godot # Check comment periods - - godox # Detect TODO/FIXME comments - - gocognit # Cognitive complexity - - gocyclo # Cyclomatic complexity - - funlen # Function length - - maintidx # Maintainability index + - revive # Fast, configurable linter + - gocritic # Opinionated Go source code linter + - godot # Check comment periods + - godox # Detect TODO/FIXME comments + - gocognit # Cognitive complexity + - gocyclo # Cyclomatic complexity + - funlen # Function length + - maintidx # Maintainability index # Security - - gosec # Security problems + - gosec # Security problems # Performance - - prealloc # Find slice preallocation opportunities - - bodyclose # Check HTTP response body closed + - prealloc # Find slice preallocation opportunities + - bodyclose # Check HTTP response body closed # Style and formatting - - goconst # Find repeated strings - - misspell # Find misspellings - - whitespace # Find unnecessary blank lines - - unconvert # Remove unnecessary type conversions - - dupword # Check for duplicate words + - goconst # Find repeated strings + - misspell # Find misspellings + - whitespace # Find unnecessary blank lines + - unconvert # Remove unnecessary type conversions + - dupword # Check for duplicate words # Error handling - - errorlint # Error handling improvements - - wrapcheck # Check error wrapping + - errorlint # Error handling improvements + - wrapcheck # Check error wrapping # Testing - - testifylint # Testify usage - - tparallel # Detect improper t.Parallel() usage - - thelper # Detect test helpers without t.Helper() + - testifylint # Testify usage + - tparallel # Detect improper t.Parallel() usage + - thelper # Detect test helpers without t.Helper() # Best practices - - exhaustive # Check exhaustiveness of enum switches - - nolintlint # Check nolint directives - - nakedret # Find naked returns - - nilnil # Check for redundant nil checks - - noctx # Check sending HTTP requests without context - - contextcheck # Check context propagation - - asciicheck # Check for non-ASCII identifiers - - bidichk # Check for dangerous unicode sequences + - exhaustive # Check exhaustiveness of enum switches + - nolintlint # Check nolint directives + - nakedret # Find naked returns + - nilnil # Check for redundant nil checks + - noctx # Check sending HTTP requests without context + - contextcheck # Check context propagation + - asciicheck # Check for non-ASCII identifiers + - bidichk # Check for dangerous unicode sequences - durationcheck # Check for multiplied durations - - makezero # Find slice declarations with non-zero length - - nilerr # Find code returning nil with non-nil error - - predeclared # Find code shadowing predeclared identifiers - - promlinter # Check Prometheus metrics naming - - reassign # Check reassignment of package variables + - makezero # Find slice declarations with non-zero length + - nilerr # Find code returning nil with non-nil error + - predeclared # Find code shadowing predeclared identifiers + - promlinter # Check Prometheus metrics naming + - reassign # Check reassignment of package variables - usestdlibvars # Use variables from stdlib - - wastedassign # Find wasted assignments + - wastedassign # Find wasted assignments # Documentation - - godoclint # Check godoc comments + - godoclint # Check godoc comments # New - - modernize # Suggest simplifications using new Go features + - modernize # Suggest simplifications using new Go features # Exclusion rules for linters exclusions: @@ -221,8 +221,8 @@ linters: govet: enable-all: true disable: - - fieldalignment # Too many false positives - - shadow # Can be noisy + - fieldalignment # Too many false positives + - shadow # Can be noisy # goconst settings goconst: @@ -286,8 +286,8 @@ linters: severity: medium confidence: medium excludes: - - G104 # Handled by errcheck - - G304 # File path provided as taint input + - G104 # Handled by errcheck + - G304 # File path provided as taint input # revive settings revive: @@ -349,7 +349,15 @@ linters: # stylecheck settings staticcheck: - checks: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"] + checks: [ + "all", + "-ST1000", + "-ST1003", + "-ST1016", + "-ST1020", + "-ST1021", + "-ST1022", + ] # maintidx settings maintidx: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..c5ef4d8 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,75 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v6.0.0 + hooks: + # File quality + - id: trailing-whitespace + exclude: '^\.github/ISSUE_TEMPLATE/.*\.yml$' + - id: end-of-file-fixer + - id: mixed-line-ending + args: ["--fix=lf"] + + # File validation + - id: check-yaml + - id: check-json + - id: check-toml + + # Security + - id: detect-private-key + + # Git safety + - id: check-merge-conflict + - id: check-case-conflict + - id: no-commit-to-branch + args: ["--branch=master", "--branch=main"] + + # File structure + - id: check-added-large-files + - id: check-symlinks + - id: check-executables-have-shebangs + - repo: local + hooks: + - id: actionlint + name: Lint GitHub Actions workflow files + description: Runs actionlint to lint GitHub Actions workflow files + language: golang + types: ["yaml"] + files: ^\.github/workflows/ + entry: actionlint + minimum_pre_commit_version: 3.0.0 + - repo: https://github.com/golangci/golangci-lint + rev: v2.7.2 + hooks: + - id: golangci-lint + name: golangci-lint + description: Fast linters runner for Go. Note that only modified files are linted, so linters like 'unused' that need to scan all files won't work as expected. + entry: golangci-lint run --new-from-rev HEAD --fix + types: [go] + language: golang + require_serial: true + pass_filenames: false + # - id: golangci-lint-full + # name: golangci-lint-full + # description: Fast linters runner for Go. Runs on all files in the module. Use this hook if you use pre-commit in CI. + # entry: golangci-lint run --fix + # types: [go] + # language: golang + # require_serial: true + # pass_filenames: false + - id: golangci-lint-fmt + name: golangci-lint-fmt + description: Fast linters runner for Go. Formats all files in the repo. + entry: golangci-lint fmt + types: [go] + language: golang + require_serial: true + pass_filenames: false + - id: golangci-lint-config-verify + name: golangci-lint-config-verify + description: Verifies the configuration file + entry: golangci-lint config verify + files: '\.golangci\.(?:yml|yaml|toml|json)' + language: golang + pass_filenames: false diff --git a/AGENTS.md b/AGENTS.md index d0b5c1e..547ffa3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,6 +2,11 @@ A Go CLI tool that parses Articulate Rise courses from URLs or local JSON files and exports them to Markdown, HTML, or DOCX formats. +## Repository Info + +- **GitHub**: https://github.com/kjanat/articulate-parser +- **Default branch**: `master` (not `main`) + ## Build/Test Commands ### Primary Commands (using Taskfile) diff --git a/DOCKER.md b/DOCKER.md index b8ae1d5..0b28b1b 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -49,17 +49,17 @@ docker run --rm ghcr.io/kjanat/articulate-parser:latest --version ## Available Tags -- `latest` - Latest stable release -- `v1.x.x` - Specific version tags -- `main` - Latest development build +- `latest` - Latest stable release +- `v1.x.x` - Specific version tags +- `main` - Latest development build ## Image Details -- **Base Image**: `scratch` (minimal attack surface) -- **Architecture**: Multi-arch support (amd64, arm64) -- **Size**: < 10MB (optimized binary) -- **Security**: Runs as non-root user -- **Features**: SBOM and provenance attestation included +- **Base Image**: `scratch` (minimal attack surface) +- **Architecture**: Multi-arch support (amd64, arm64) +- **Size**: < 10MB (optimized binary) +- **Security**: Runs as non-root user +- **Features**: SBOM and provenance attestation included ## Development @@ -77,6 +77,6 @@ docker-compose up --build ## Repository -- **Source**: [github.com/kjanat/articulate-parser](https://github.com/kjanat/articulate-parser) -- **Issues**: [Report bugs or request features](https://github.com/kjanat/articulate-parser/issues) -- **License**: See repository for license details +- **Source**: [github.com/kjanat/articulate-parser](https://github.com/kjanat/articulate-parser) +- **Issues**: [Report bugs or request features](https://github.com/kjanat/articulate-parser/issues) +- **License**: See repository for license details diff --git a/Dockerfile b/Dockerfile index 59b938e..b365d8e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -27,7 +27,7 @@ ARG BUILD_TIME ARG GIT_COMMIT # Docker buildx automatically provides these for multi-platform builds ARG BUILDPLATFORM -ARG TARGETPLATFORM +ARG TARGETPLATFORM ARG TARGETOS ARG TARGETARCH ARG TARGETVARIANT diff --git a/Dockerfile.dev b/Dockerfile.dev index 47e34b9..4cfe848 100644 --- a/Dockerfile.dev +++ b/Dockerfile.dev @@ -30,7 +30,7 @@ ARG BUILD_TIME ARG GIT_COMMIT # Docker buildx automatically provides these for multi-platform builds ARG BUILDPLATFORM -ARG TARGETPLATFORM +ARG TARGETPLATFORM ARG TARGETOS ARG TARGETARCH ARG TARGETVARIANT diff --git a/README.md b/README.md index fc2fbfb..198b4c8 100644 --- a/README.md +++ b/README.md @@ -20,36 +20,36 @@ A Go-based parser that converts Articulate Rise e-learning content to various fo flowchart TD %% User Input CLI[Command Line Interface
main.go] --> APP{App Service
services/app.go} - + %% Core Application Logic APP --> |"ProcessCourseFromURI"| PARSER[Course Parser
services/parser.go] APP --> |"ProcessCourseFromFile"| PARSER APP --> |"exportCourse"| FACTORY[Exporter Factory
exporters/factory.go] - + %% Data Sources PARSER --> |"FetchCourse"| API[Articulate Rise API
rise.articulate.com] PARSER --> |"LoadCourseFromFile"| FILE[Local JSON File
*.json] - + %% Data Models API --> MODELS[Data Models
models/course.go] FILE --> MODELS MODELS --> |Course, Lesson, Item| APP - + %% Export Factory Pattern FACTORY --> |"CreateExporter"| MARKDOWN[Markdown Exporter
exporters/markdown.go] FACTORY --> |"CreateExporter"| HTML[HTML Exporter
exporters/html.go] FACTORY --> |"CreateExporter"| DOCX[DOCX Exporter
exporters/docx.go] - + %% HTML Cleaning Service CLEANER[HTML Cleaner
services/html_cleaner.go] --> MARKDOWN CLEANER --> HTML CLEANER --> DOCX - + %% Output Files MARKDOWN --> |"Export"| MD_OUT[Markdown Files
*.md] HTML --> |"Export"| HTML_OUT[HTML Files
*.html] DOCX --> |"Export"| DOCX_OUT[Word Documents
*.docx] - + %% Interfaces (Contracts) IPARSER[CourseParser Interface
interfaces/parser.go] -.-> PARSER IEXPORTER[Exporter Interface
interfaces/exporter.go] -.-> MARKDOWN @@ -64,7 +64,7 @@ flowchart TD classDef output fill:#fce7f3,stroke:#be185d,stroke-width:2px,color:#be185d classDef interface fill:#ecfdf5,stroke:#16a34a,stroke-width:1px,stroke-dasharray: 5 5,color:#16a34a classDef service fill:#cffafe,stroke:#0891b2,stroke-width:2px,color:#0891b2 - + class CLI userInput class APP,FACTORY coreLogic class API,FILE,MODELS dataSource @@ -78,32 +78,32 @@ flowchart TD The system follows **Clean Architecture** principles with clear separation of concerns: -- **đŸŽ¯ Entry Point**: Command-line interface handles user input and coordinates operations -- **🏗ī¸ Application Layer**: Core business logic with dependency injection -- **📋 Interface Layer**: Contracts defining behavior without implementation details -- **🔧 Service Layer**: Concrete implementations of parsing and utility services -- **📤 Export Layer**: Factory pattern for format-specific exporters -- **📊 Data Layer**: Domain models representing course structure +- **đŸŽ¯ Entry Point**: Command-line interface handles user input and coordinates operations +- **🏗ī¸ Application Layer**: Core business logic with dependency injection +- **📋 Interface Layer**: Contracts defining behavior without implementation details +- **🔧 Service Layer**: Concrete implementations of parsing and utility services +- **📤 Export Layer**: Factory pattern for format-specific exporters +- **📊 Data Layer**: Domain models representing course structure ## Features -- Parse Articulate Rise JSON data from URLs or local files -- Export to Markdown (.md) format -- Export to HTML (.html) format with professional styling -- Export to Word Document (.docx) format -- Support for various content types: - - Text content with headings and paragraphs - - Lists and bullet points - - Multimedia content (videos and images) - - Knowledge checks and quizzes - - Interactive content (flashcards) - - Course structure and metadata +- Parse Articulate Rise JSON data from URLs or local files +- Export to Markdown (.md) format +- Export to HTML (.html) format with professional styling +- Export to Word Document (.docx) format +- Support for various content types: + - Text content with headings and paragraphs + - Lists and bullet points + - Multimedia content (videos and images) + - Knowledge checks and quizzes + - Interactive content (flashcards) + - Course structure and metadata ## Installation ### Prerequisites -- Go, I don't know the version, but I have [![Go version](https://img.shields.io/github/go-mod/go-version/kjanat/articulate-parser?label=)][gomod] configured right now, and it works, see the [CI][Build] workflow where it is tested. +- Go, I don't know the version, but I have [![Go version](https://img.shields.io/github/go-mod/go-version/kjanat/articulate-parser?label=)][gomod] configured right now, and it works, see the [CI][Build] workflow where it is tested. ### Install from source @@ -124,7 +124,7 @@ go install github.com/kjanat/articulate-parser@latest The parser uses the following external library: -- `github.com/fumiama/go-docx` - For creating Word documents (MIT license) +- `github.com/fumiama/go-docx` - For creating Word documents (MIT license) ## Testing @@ -164,25 +164,25 @@ go run main.go [output_path] #### Examples -1. **Parse from URL and export to Markdown:** +1. **Parse from URL and export to Markdown:** ```bash go run main.go "https://rise.articulate.com/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO#/" md ``` -2. **Parse from local file and export to Word:** +2. **Parse from local file and export to Word:** ```bash go run main.go "articulate-sample.json" docx "my-course.docx" ``` -3. **Parse from local file and export to HTML:** +3. **Parse from local file and export to HTML:** ```bash go run main.go "articulate-sample.json" html "output.html" ``` -4. **Parse from local file and export to Markdown:** +4. **Parse from local file and export to Markdown:** ```bash go run main.go "articulate-sample.json" md "output.md" @@ -225,14 +225,14 @@ docker run --rm ghcr.io/kjanat/articulate-parser:latest --help ### Available Tags -| Tag | Description | Use Case | -|-----|-------------|----------| -| `latest` | Latest stable release from master branch | Production use | -| `edge` | Latest development build from master branch | Testing new features | -| `v1.x.x` | Specific version releases | Production pinning | -| `develop` | Development branch builds | Development/testing | -| `feature/docker-ghcr` | Feature branch builds | Feature testing | -| `master` | Latest master branch build | Continuous integration | +| Tag | Description | Use Case | +| --------------------- | ------------------------------------------- | ---------------------- | +| `latest` | Latest stable release from master branch | Production use | +| `edge` | Latest development build from master branch | Testing new features | +| `v1.x.x` | Specific version releases | Production pinning | +| `develop` | Development branch builds | Development/testing | +| `feature/docker-ghcr` | Feature branch builds | Feature testing | +| `master` | Latest master branch build | Continuous integration | ### Usage Examples @@ -313,11 +313,11 @@ docker build --build-arg VERSION=local --build-arg BUILD_TIME=$(date -u +%Y-%m-% The Docker image supports the following build-time arguments: -| Argument | Description | Default | -|----------|-------------|---------| -| `VERSION` | Version string embedded in the binary | `dev` | -| `BUILD_TIME` | Build timestamp | Current time | -| `GIT_COMMIT` | Git commit hash | Current commit | +| Argument | Description | Default | +| ------------ | ------------------------------------- | -------------- | +| `VERSION` | Version string embedded in the binary | `dev` | +| `BUILD_TIME` | Build timestamp | Current time | +| `GIT_COMMIT` | Git commit hash | Current commit | ### Docker Security @@ -332,88 +332,88 @@ The Docker image supports the following build-time arguments: The project maintains high code quality standards: -- Cyclomatic complexity ≤ 15 (checked with [gocyclo](https://github.com/fzipp/gocyclo)) -- Race condition detection enabled -- Comprehensive test coverage -- Code formatting with `gofmt` -- Static analysis with `go vet` +- Cyclomatic complexity ≤ 15 (checked with [gocyclo](https://github.com/fzipp/gocyclo)) +- Race condition detection enabled +- Comprehensive test coverage +- Code formatting with `gofmt` +- Static analysis with `go vet` ### Contributing -1. Fork the repository -2. Create a feature branch -3. Make your changes -4. Run tests: `go test ./...` -5. Submit a pull request +1. Fork the repository +2. Create a feature branch +3. Make your changes +4. Run tests: `go test ./...` +5. Submit a pull request ## Output Formats ### Markdown (`.md`) -- Hierarchical structure with proper heading levels -- Clean text content with HTML tags removed -- Lists and bullet points preserved -- Quiz questions with correct answers marked -- Media references included -- Course metadata at the top +- Hierarchical structure with proper heading levels +- Clean text content with HTML tags removed +- Lists and bullet points preserved +- Quiz questions with correct answers marked +- Media references included +- Course metadata at the top ### HTML (`.html`) -- Professional styling with embedded CSS -- Interactive and visually appealing layout -- Proper HTML structure with semantic elements -- Responsive design for different screen sizes -- All content types beautifully formatted -- Maintains course hierarchy and organization +- Professional styling with embedded CSS +- Interactive and visually appealing layout +- Proper HTML structure with semantic elements +- Responsive design for different screen sizes +- All content types beautifully formatted +- Maintains course hierarchy and organization ### Word Document (`.docx`) -- Professional document formatting -- Bold headings and proper typography -- Bulleted lists -- Quiz questions with answers -- Media content references -- Maintains course structure +- Professional document formatting +- Bold headings and proper typography +- Bulleted lists +- Quiz questions with answers +- Media content references +- Maintains course structure ## Supported Content Types The parser handles the following Articulate Rise content types: -- **Text blocks**: Headings and paragraphs -- **Lists**: Bullet points and numbered lists -- **Multimedia**: Videos and images (references only) -- **Knowledge Checks**: Multiple choice, multiple response, fill-in-the-blank, matching -- **Interactive Content**: Flashcards and interactive scenarios -- **Dividers**: Section breaks -- **Sections**: Course organization +- **Text blocks**: Headings and paragraphs +- **Lists**: Bullet points and numbered lists +- **Multimedia**: Videos and images (references only) +- **Knowledge Checks**: Multiple choice, multiple response, fill-in-the-blank, matching +- **Interactive Content**: Flashcards and interactive scenarios +- **Dividers**: Section breaks +- **Sections**: Course organization ## Data Structure The parser works with the standard Articulate Rise JSON format which includes: -- Course metadata (title, description, settings) -- Lesson structure -- Content items with various types -- Media references -- Quiz/assessment data -- Styling and layout information +- Course metadata (title, description, settings) +- Lesson structure +- Content items with various types +- Media references +- Quiz/assessment data +- Styling and layout information ## URL Pattern Recognition The parser automatically extracts share IDs from Articulate Rise URLs: -- Input: `https://rise.articulate.com/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO#/` -- API URL: `https://rise.articulate.com/api/rise-runtime/boot/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO` +- Input: `https://rise.articulate.com/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO#/` +- API URL: `https://rise.articulate.com/api/rise-runtime/boot/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO` ## Error Handling The parser includes error handling for: -- Invalid URLs or share IDs -- Network connection issues -- Malformed JSON data -- File I/O errors -- Unsupported content types +- Invalid URLs or share IDs +- Network connection issues +- Malformed JSON data +- File I/O errors +- Unsupported content types + [MIT License]: LICENSE [Package documentation]: https://godoc.org/github.com/kjanat/articulate-parser [Tags]: https://github.com/kjanat/articulate-parser/tags diff --git a/Taskfile.yml b/Taskfile.yml index a0432e6..682f003 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -210,13 +210,13 @@ tasks: sh: gofmt -s -l . cmds: - | - {{if ne .UNFORMATTED ""}} - echo "❌ The following files need formatting:" - echo "{{.UNFORMATTED}}" - exit 1 - {{else}} - echo "All files are properly formatted" - {{end}} + {{if ne .UNFORMATTED ""}} + echo "❌ The following files need formatting:" + echo "{{.UNFORMATTED}}" + exit 1 + {{else}} + echo "All files are properly formatted" + {{end}} lint:staticcheck: desc: Run staticcheck (install if needed) @@ -304,22 +304,22 @@ tasks: aliases: [db] cmds: - | - docker build \ - --build-arg VERSION={{.VERSION}} \ - --build-arg BUILD_TIME={{.BUILD_TIME}} \ - --build-arg GIT_COMMIT={{.GIT_COMMIT}} \ - -t {{.APP_NAME}}:{{.VERSION}} \ - -t {{.APP_NAME}}:latest \ - . + docker build \ + --build-arg VERSION={{.VERSION}} \ + --build-arg BUILD_TIME={{.BUILD_TIME}} \ + --build-arg GIT_COMMIT={{.GIT_COMMIT}} \ + -t {{.APP_NAME}}:{{.VERSION}} \ + -t {{.APP_NAME}}:latest \ + . - > - echo "Docker image built: {{.APP_NAME}}:{{.VERSION}}" + echo "Docker image built: {{.APP_NAME}}:{{.VERSION}}" docker:build:dev: desc: Build development Docker image cmds: - docker build -f Dockerfile.dev -t {{.APP_NAME}}:dev . - > - echo "Development Docker image built: {{.APP_NAME}}:dev" + echo "Development Docker image built: {{.APP_NAME}}:dev" docker:run: desc: Run Docker container @@ -426,7 +426,7 @@ tasks: - git tag -a v{{.VERSION}} -m "Release v{{.VERSION}}" - echo "Tagged v{{.VERSION}}" - > - echo "Push with: git push origin v{{.VERSION}}" + echo "Push with: git push origin v{{.VERSION}}" # Documentation tasks docs:serve: diff --git a/internal/exporters/html.go b/internal/exporters/html.go index f35781e..e3391d1 100644 --- a/internal/exporters/html.go +++ b/internal/exporters/html.go @@ -15,7 +15,7 @@ import ( //go:embed html_styles.css var defaultCSS string -//go:embed html_template.html +//go:embed html_template.gohtml var htmlTemplate string // HTMLExporter implements the Exporter interface for HTML format. diff --git a/internal/exporters/html_styles.css b/internal/exporters/html_styles.css index 8448d1b..7952763 100644 --- a/internal/exporters/html_styles.css +++ b/internal/exporters/html_styles.css @@ -1,173 +1,175 @@ body { - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif; - line-height: 1.6; - color: #333; - max-width: 800px; - margin: 0 auto; - padding: 20px; - background-color: #f9f9f9; + font-family: + -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, + Cantarell, sans-serif; + line-height: 1.6; + color: #333; + max-width: 800px; + margin: 0 auto; + padding: 20px; + background-color: #f9f9f9; } header { - background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); - color: white; - padding: 2rem; - border-radius: 10px; - margin-bottom: 2rem; - box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1); + background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); + color: white; + padding: 2rem; + border-radius: 10px; + margin-bottom: 2rem; + box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1); } header h1 { - margin: 0; - font-size: 2.5rem; - font-weight: 300; + margin: 0; + font-size: 2.5rem; + font-weight: 300; } .course-description { - margin-top: 1rem; - font-size: 1.1rem; - opacity: 0.9; + margin-top: 1rem; + font-size: 1.1rem; + opacity: 0.9; } .course-info { - background: white; - padding: 1.5rem; - border-radius: 8px; - margin-bottom: 2rem; - box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + background: white; + padding: 1.5rem; + border-radius: 8px; + margin-bottom: 2rem; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); } .course-info h2 { - margin-top: 0; - color: #4a5568; - border-bottom: 2px solid #e2e8f0; - padding-bottom: 0.5rem; + margin-top: 0; + color: #4a5568; + border-bottom: 2px solid #e2e8f0; + padding-bottom: 0.5rem; } .course-info ul { - list-style: none; - padding: 0; + list-style: none; + padding: 0; } .course-info li { - margin: 0.5rem 0; - padding: 0.5rem; - background: #f7fafc; - border-radius: 4px; + margin: 0.5rem 0; + padding: 0.5rem; + background: #f7fafc; + border-radius: 4px; } .course-section { - background: #4299e1; - color: white; - padding: 1.5rem; - border-radius: 8px; - margin: 2rem 0; - box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + background: #4299e1; + color: white; + padding: 1.5rem; + border-radius: 8px; + margin: 2rem 0; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); } .course-section h2 { - margin: 0; - font-weight: 400; + margin: 0; + font-weight: 400; } .lesson { - background: white; - padding: 2rem; - border-radius: 8px; - margin: 2rem 0; - box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); - border-left: 4px solid #4299e1; + background: white; + padding: 2rem; + border-radius: 8px; + margin: 2rem 0; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + border-left: 4px solid #4299e1; } .lesson h3 { - margin-top: 0; - color: #2d3748; - font-size: 1.5rem; + margin-top: 0; + color: #2d3748; + font-size: 1.5rem; } .lesson-description { - margin: 1rem 0; - padding: 1rem; - background: #f7fafc; - border-radius: 4px; - border-left: 3px solid #4299e1; + margin: 1rem 0; + padding: 1rem; + background: #f7fafc; + border-radius: 4px; + border-left: 3px solid #4299e1; } .item { - margin: 1.5rem 0; - padding: 1rem; - border-radius: 6px; - background: #fafafa; - border: 1px solid #e2e8f0; + margin: 1.5rem 0; + padding: 1rem; + border-radius: 6px; + background: #fafafa; + border: 1px solid #e2e8f0; } .item h4 { - margin-top: 0; - color: #4a5568; - font-size: 1.2rem; - text-transform: capitalize; + margin-top: 0; + color: #4a5568; + font-size: 1.2rem; + text-transform: capitalize; } .text-item { - background: #f0fff4; - border-left: 3px solid #48bb78; + background: #f0fff4; + border-left: 3px solid #48bb78; } .list-item { - background: #fffaf0; - border-left: 3px solid #ed8936; + background: #fffaf0; + border-left: 3px solid #ed8936; } .knowledge-check { - background: #e6fffa; - border-left: 3px solid #38b2ac; + background: #e6fffa; + border-left: 3px solid #38b2ac; } .multimedia-item { - background: #faf5ff; - border-left: 3px solid #9f7aea; + background: #faf5ff; + border-left: 3px solid #9f7aea; } .interactive-item { - background: #fff5f5; - border-left: 3px solid #f56565; + background: #fff5f5; + border-left: 3px solid #f56565; } .unknown-item { - background: #f7fafc; - border-left: 3px solid #a0aec0; + background: #f7fafc; + border-left: 3px solid #a0aec0; } .answers { - margin: 1rem 0; + margin: 1rem 0; } .answers h5 { - margin: 0.5rem 0; - color: #4a5568; + margin: 0.5rem 0; + color: #4a5568; } .answers ol { - margin: 0.5rem 0; - padding-left: 1.5rem; + margin: 0.5rem 0; + padding-left: 1.5rem; } .answers li { - margin: 0.3rem 0; - padding: 0.3rem; + margin: 0.3rem 0; + padding: 0.3rem; } .correct-answer { - background: #c6f6d5; - border-radius: 3px; - font-weight: bold; + background: #c6f6d5; + border-radius: 3px; + font-weight: bold; } .correct-answer::after { - content: " ✓"; - color: #38a169; + content: " ✓"; + color: #38a169; } .feedback { - margin: 1rem 0; - padding: 1rem; - background: #edf2f7; - border-radius: 4px; - border-left: 3px solid #4299e1; - font-style: italic; + margin: 1rem 0; + padding: 1rem; + background: #edf2f7; + border-radius: 4px; + border-left: 3px solid #4299e1; + font-style: italic; } .media-info { - background: #edf2f7; - padding: 1rem; - border-radius: 4px; - margin: 0.5rem 0; + background: #edf2f7; + padding: 1rem; + border-radius: 4px; + margin: 0.5rem 0; } .media-info strong { - color: #4a5568; + color: #4a5568; } hr { - border: none; - height: 2px; - background: linear-gradient(to right, #667eea, #764ba2); - margin: 2rem 0; - border-radius: 1px; + border: none; + height: 2px; + background: linear-gradient(to right, #667eea, #764ba2); + margin: 2rem 0; + border-radius: 1px; } ul { - padding-left: 1.5rem; + padding-left: 1.5rem; } li { - margin: 0.5rem 0; + margin: 0.5rem 0; } diff --git a/internal/exporters/html_template.html b/internal/exporters/html_template.gohtml similarity index 100% rename from internal/exporters/html_template.html rename to internal/exporters/html_template.gohtml diff --git a/internal/exporters/output.md b/internal/exporters/output.md index be78d86..e855c50 100644 --- a/internal/exporters/output.md +++ b/internal/exporters/output.md @@ -4,9 +4,8 @@ Course description ## Course Information -- **Course ID**: +- **Course ID**: - **Share ID**: example-id -- **Navigation Mode**: +- **Navigation Mode**: --- - diff --git a/scripts/build.ps1 b/scripts/build.ps1 index eb3ce1d..99396cd 100644 --- a/scripts/build.ps1 +++ b/scripts/build.ps1 @@ -137,7 +137,7 @@ try { # Show targets and exit if requested if ($ShowTargets) { Write-Host 'Available build targets:' -ForegroundColor Cyan - + # Get available platforms and architectures from Go toolchain try { $GoTargets = @(go tool dist list 2>$null) @@ -148,7 +148,7 @@ try { Write-Host '⚠ī¸ Could not retrieve targets from Go. Using default targets.' -ForegroundColor Yellow $PlatformList = $Platforms.Split(',') | ForEach-Object { $_.Trim() } $ArchList = $Architectures.Split(',') | ForEach-Object { $_.Trim() } - + foreach ($platform in $PlatformList) { foreach ($arch in $ArchList) { $BinaryName = "articulate-parser-$platform-$arch" @@ -163,12 +163,12 @@ try { $SelectedTargets = @() $PlatformList = $Platforms.Split(',') | ForEach-Object { $_.Trim() } $ArchList = $Architectures.Split(',') | ForEach-Object { $_.Trim() } - + foreach ($target in $GoTargets) { $parts = $target.Split('/') $platform = $parts[0] $arch = $parts[1] - + if ($PlatformList -contains $platform -and $ArchList -contains $arch) { $SelectedTargets += @{ Platform = $platform @@ -177,14 +177,14 @@ try { } } } - + # Display filtered targets foreach ($target in $SelectedTargets) { $BinaryName = "articulate-parser-$($target.Platform)-$($target.Arch)" if ($target.Platform -eq 'windows') { $BinaryName += '.exe' } Write-Host " $($target.Original) -> $BinaryName" -ForegroundColor Gray } - + # Show all available targets if verbose if ($VerboseOutput) { Write-Host "`nAll Go targets available on this system:" -ForegroundColor Cyan @@ -404,13 +404,13 @@ try { } $BuildArgs += '-o' $BuildArgs += $Target.Path - + # If using custom entry point that's not main.go # we need to use the file explicitly to avoid duplicate declarations $EntryPointPath = Join-Path $ProjectRoot $EntryPoint $EntryPointFile = Split-Path $EntryPointPath -Leaf $IsCustomEntryPoint = ($EntryPointFile -ne 'main.go') - + if ($IsCustomEntryPoint) { # When using custom entry point, compile only that file $BuildArgs += $EntryPointPath @@ -419,7 +419,7 @@ try { $PackagePath = Split-Path $EntryPointPath -Parent $BuildArgs += $PackagePath } - + # For verbose output, show the command that will be executed if ($VerboseOutput) { Write-Host "Command: go $($BuildArgs -join ' ')" -ForegroundColor DarkCyan diff --git a/scripts/build.sh b/scripts/build.sh index d0739ad..f6e53f0 100644 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -73,7 +73,7 @@ EXAMPLES: DEFAULT TARGETS: Operating Systems: darwin, freebsd, linux, windows Architectures: amd64, arm64 - + This creates 8 binaries total (4 OS × 2 ARCH) GO BUILD FLAGS: