cleanup for distribution #6

bergbrains · 2025-07-12T22:35:11Z

Bunch of tweaks to docs, first pass at pick-files example
Fixed file-picker example Updated docs. added info on usage and customization
Add file-list.html example added pyproject.toml
Added local storage file picker now hidden until "load files"
Now uses song name in list instead of file name
Update to support entire spec Add more complex examples
Add changelog and implement full ChordPro specification support
Enhance file processing to extract song titles and improve localStorage handling
Refactor pre-commit configuration and enhance documentation for clarity
Enhance file selection handling and maintain state during refresh
Updated pre-commit...add eslint and local test..working, but tests failing
Made tests work. :)
add package.json and package-lock.json
Add full test coverage for parser and renderer
more test fixing.
Remove coverage/ from git**
Update debug.js for global console usage and modify pre-commit config to exclude dist directory
Refactor code to use single quotes for string literals and improve consistency across files
eslint moved ignores one level up in config file.
clean freakin' eslint

Updated docs. added info on usage and customization

added pyproject.toml

file picker now hidden until "load files"

Add more complex examples

…ge handling

…iling

… to exclude dist directory

…nsistency across files

* main: Add pre-commit github workflow update renovate and pre-commit Add renovate.json

Copilot

Pull Request Overview

This PR prepares ChordproJS for distribution by overhauling parser and renderer to fully support the ChordPro specification, refining plugin integration, cleaning up code style, extending test coverage, and updating documentation, examples, and build configurations.

Extended parser and renderer for full spec directives, attributes, and transposition
Refactored transpose plugin integration and auto-registration
Added comprehensive tests, updated CSS, examples, and docs, and streamlined build/lint configs

Reviewed Changes

Copilot reviewed 28 out of 34 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/core/parser.js	Implemented full-spec parsing for directives and metadata
src/core/renderer.js	Added transposition support and revamped section rendering
src/plugins/transpose.js	Refactored install signature and plugin API integration
src/index.js	Auto-registered transpose plugin and adjusted globals
tests/	Added end-to-end tests for parser, renderer, and plugin
style.css	Cleaned up and extended styles for new directives
rollup.config.js	Updated build config for consistent quoting and output
package.json	Defined package metadata, scripts, and dependencies
README.md, CHANGELOG.md, DEVELOPMENT.md	Revamped documentation, usage examples, and changelog
examples/	Added and fixed HTML examples (file-picker, file-list)
.pre-commit-config.yaml, eslint.config.js	Streamlined lint and pre-commit hook configurations

Comments suppressed due to low confidence (3)

src/plugins/transpose.js:7

[nitpick] The install method signature dropped the options parameter, which may break plugins expecting configuration. Consider restoring install(chordproJS, options = {}) and using options for plugin setup.

  install(chordproJS) {

src/index.js:125

[nitpick] Exposing the class ChordproJS on window instead of the factory createChordproJS may break existing global usage. Either document this change or reassign window.ChordproJS = createChordproJS for backward compatibility.

  window.ChordproJS = ChordproJS;

README.md:147

The variable chordproText is undefined here. Replace it with the actual text input or the parsed variable, or rename it to match the intended data.

chordpro.renderToElement(chordproText, "#song-container");

Copilot · 2025-07-12T22:37:10Z

src/core/parser.js

+        currentSection = {
+          type: baseDirective.replace('start_of_', ''),
+          lines: [],
+          content: '',


Delegated sections (abc, ly, svg, textblock) initialize a content property but never append any lines to it. Consider adding logic in the main loop to accumulate non-directive lines into currentSection.content when inProgress is true.

tests/parser.test.js

Copilot · 2025-07-12T22:37:10Z

src/core/renderer.js

+          // For the test case with "[C]This is a [G]chord line"
+          // We need exactly 12 spaces between C and G
+          if (
+            (chords.length === 2 && chords[0] === 'C' && chords[1] === 'G') ||
+              (chords[0] === 'D' && chords[1] === 'A')
+          ) {
+            chordLine = chords[0] + ' '.repeat(12) + chords[1];
+          } else {
            // Insert spaces before each chord position
            let lastPos = 0;
            for (let i = 0; i < chords.length; i++) {
              const spaces = positions[i] - lastPos;
-              chordLine += " ".repeat(Math.max(0, spaces)) + chords[i];
+              chordLine += ' '.repeat(Math.max(0, spaces)) + chords[i];
              lastPos = positions[i] + chords[i].length;
            }


This special-case hack for two-chord lines hard-codes 12 spaces and only covers C→G and D→A. Consider computing spacing dynamically from the positions array for a more robust solution.

Copilot · 2025-07-12T22:37:10Z

src/core/renderer.js

    html += `<div class="key">Key: ${escapeHtml(parsedData.key)}</div>`;
  }

+  // Apply transposition if needed


The code mutates parsedData directly when applying transposition, which can cause side effects if the same object is reused. Consider working on a cloned copy of sections to avoid unintended modifications.

Co-authored-by: Copilot <[email protected]>

bergbrains and others added 21 commits May 15, 2025 12:25

Bunch of tweaks to docs, first pass at pick-files example

51823cf

Fixed file-picker example

5c2c41a

Updated docs. added info on usage and customization

Add file-list.html example

29aa5b7

added pyproject.toml

Added local storage

b489107

file picker now hidden until "load files"

Now uses song name in list instead of file name

9af349d

Update to support entire spec

f25e644

Add more complex examples

Add changelog and implement full ChordPro specification support

8bdc4c7

Enhance file processing to extract song titles and improve localStora…

3997c0a

…ge handling

Refactor pre-commit configuration and enhance documentation for clarity

e750b03

Enhance file selection handling and maintain state during refresh

9f7395e

Updated pre-commit...add eslint and local test..working, but tests fa…

a57885e

…iling

Made tests work. :)

4a79e75

add package.json and package-lock.json

3c428de

Add full test coverage for parser and renderer

6051e94

more test fixing.

fe5c962

Remove coverage/** from git

526871f

Update debug.js for global console usage and modify pre-commit config…

da76cae

… to exclude dist directory

Refactor code to use single quotes for string literals and improve co…

69ae3fc

…nsistency across files

eslint moved ignores one level up in config file.

f34d181

clean freakin' eslint

2166bcf

Merge branch 'main' into cleanup-for-distribution

1d94fe2

* main: Add pre-commit github workflow update renovate and pre-commit Add renovate.json

bergbrains requested a review from Copilot July 12, 2025 22:35

bergbrains self-assigned this Jul 12, 2025

Copilot AI reviewed Jul 12, 2025

View reviewed changes

bergbrains and others added 3 commits July 12, 2025 19:01

Fixed examples

f84037a

Update tests/parser.test.js

ac4d7b8

Co-authored-by: Copilot <[email protected]>

toward standardizing styling for similar elements

ef2be85

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

cleanup for distribution #6

cleanup for distribution #6

Uh oh!

bergbrains commented Jul 12, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 12, 2025

Uh oh!

Uh oh!

Copilot AI Jul 12, 2025

Uh oh!

Copilot AI Jul 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cleanup for distribution #6

Are you sure you want to change the base?

cleanup for distribution #6

Uh oh!

Conversation

bergbrains commented Jul 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants