lyrics-structure 1.2.3 → 1.3.0

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - run: npm ci
+
+      - run: npm run build
+
+      - run: npm test
+
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierrc

@@ -1,10 +1,10 @@
-{
-  "semi": true,
-  "trailingComma": "es5",
-  "singleQuote": true,
-  "printWidth": 100,
-  "tabWidth": 2,
-  "useTabs": false,
-  "bracketSpacing": true,
-  "arrowParens": "always"
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "always"
 } 

package/.vscode/settings.json

@@ -1,19 +1,19 @@
-{
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit"
-  },
-  "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[markdown]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
-}
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

package/CHANGELOG.md

@@ -1,56 +1,56 @@
-# Changelog
-
-## [1.2.2] - 2024-04-06
-
-### Fixed
-
-- Fixed issue where consecutive lines without part containers were incorrectly split into separate parts
-- Improved handling of regular text lines to maintain proper grouping
-
-## [1.2.0] - 2024-03-XX
-
-### Changed
-
-- Simplified the lyrics format to use clear section markers
-- Updated documentation with clearer examples
-- Improved type definitions for better TypeScript support
-
-### Added
-
-- Support for section indications in parentheses
-- Better handling of repeated sections
-- More intuitive content structure
-
-### Removed
-
-- Slide-based content splitting
-- Special command tags
-- Complex formatting options
-
-## [1.1.0] - 2024-03-XX
-
-### Added
-
-- Initial release
-- `getParts` function for basic content extraction
-- `getSlideParts` function for slide-based content splitting
-- Support for special command tags
-- Comprehensive test suite
-- TypeScript types and documentation
-
-### Features
-
-- Bracketed section parsing
-- Special command tag handling
-- Slide splitting based on content length
-- Empty line separation
-- Long line handling (>40 characters)
-- Whitespace preservation
-- Unicode support in tags
-
-### Test Coverage
-
-- Basic functionality tests
-- Slide splitting tests
-- Special command tests
-- Edge case handling
+# Changelog
+
+## [1.2.2] - 2024-04-06
+
+### Fixed
+
+- Fixed issue where consecutive lines without part containers were incorrectly split into separate parts
+- Improved handling of regular text lines to maintain proper grouping
+
+## [1.2.0] - 2024-03-XX
+
+### Changed
+
+- Simplified the lyrics format to use clear section markers
+- Updated documentation with clearer examples
+- Improved type definitions for better TypeScript support
+
+### Added
+
+- Support for section indications in parentheses
+- Better handling of repeated sections
+- More intuitive content structure
+
+### Removed
+
+- Slide-based content splitting
+- Special command tags
+- Complex formatting options
+
+## [1.1.0] - 2024-03-XX
+
+### Added
+
+- Initial release
+- `getParts` function for basic content extraction
+- `getSlideParts` function for slide-based content splitting
+- Support for special command tags
+- Comprehensive test suite
+- TypeScript types and documentation
+
+### Features
+
+- Bracketed section parsing
+- Special command tag handling
+- Slide splitting based on content length
+- Empty line separation
+- Long line handling (>40 characters)
+- Whitespace preservation
+- Unicode support in tags
+
+### Test Coverage
+
+- Basic functionality tests
+- Slide splitting tests
+- Special command tests
+- Edge case handling

package/README.md

@@ -1,54 +1,54 @@
-# Lyrics Parser
-
-A TypeScript library for parsing lyrics with bracketed sections and special commands. Supports splitting text into structured parts with names and indications.
-
-## Installation
-
-```bash
-npm install lyrics-parser
-```
-
-## Usage
-
-```typescript
-import { getLyricsParts } from 'lyrics-parser';
-
-const lyrics = `[verse 1] (first time)
-This is the first verse content
-[/verse 1]
-
-[chorus]
-This is the chorus content
-[/chorus]
-
-[verse 2]
-This is the second verse content
-[/verse 2]`;
-
-const parts = getLyricsParts(lyrics);
-// Result: Array of LyricPart objects with name, repetition, indication, and content
-```
-
-## Features
-
-- Extracts content from bracketed sections
-- Handles section names and indications
-- Supports repeated sections
-- Preserves non-bracketed content
-- TypeScript support
-
-## Example Format
-
-```text
-[partname] (indication)
-content
-[/partname]
-
-[another part]
-more content
-[/another part]
-```
-
-## License
-
+# Lyrics Parser
+
+A TypeScript library for parsing lyrics with bracketed sections and special commands. Supports splitting text into structured parts with names and indications.
+
+## Installation
+
+```bash
+npm install lyrics-parser
+```
+
+## Usage
+
+```typescript
+import { getLyricsParts } from 'lyrics-parser';
+
+const lyrics = `[verse 1] (first time)
+This is the first verse content
+[/verse 1]
+
+[chorus]
+This is the chorus content
+[/chorus]
+
+[verse 2]
+This is the second verse content
+[/verse 2]`;
+
+const parts = getLyricsParts(lyrics);
+// Result: Array of LyricPart objects with name, repetition, indication, and content
+```
+
+## Features
+
+- Extracts content from bracketed sections
+- Handles section names and indications
+- Supports repeated sections
+- Preserves non-bracketed content
+- TypeScript support
+
+## Example Format
+
+```text
+[partname] (indication)
+content
+[/partname]
+
+[another part]
+more content
+[/another part]
+```
+
+## License
+
 MIT 

package/debug.ts

@@ -1,47 +1,47 @@
-import { getSlideParts } from './slide';
-
-const comprehensiveInput = `
-[verse]
-First line of verse
-Second line of verse
-Third line of verse
-Fourth line of verse
-Fifth line of verse
-[/verse]
-[verse]
-(inside parentheses)
-Regular text line 1
-Regular text line 2
-
-[chorus]
-First chorus line
-Second chorus line
-[/chorus]
-
-[verse 1]
-This is a very long line that should be considered too long for the slide
-This is another very long line that should also be considered too long
-Short line 1
-Short line 2
-[/verse 1]
-
-Regular line 1
-Regular line 2
-
-More content
-
-This is a very long line that exceeds forty characters for testing purposes
-This is another very long line that also exceeds the forty character limit
-Another very long line that should be considered too long for the slide
-And yet another very long line that should be split into a new section
-Regular line
-
-[verse 2]
-    First line with spaces    
-  Second line with spaces  
-[/verse 2]
-
-[chorus]`;
-
-console.log('Output from getSlideParts:');
-console.log(JSON.stringify(getSlideParts(comprehensiveInput), null, 2));
+import { getSlideParts } from './slide';
+
+const comprehensiveInput = `
+[verse]
+First line of verse
+Second line of verse
+Third line of verse
+Fourth line of verse
+Fifth line of verse
+[/verse]
+[verse]
+(inside parentheses)
+Regular text line 1
+Regular text line 2
+
+[chorus]
+First chorus line
+Second chorus line
+[/chorus]
+
+[verse 1]
+This is a very long line that should be considered too long for the slide
+This is another very long line that should also be considered too long
+Short line 1
+Short line 2
+[/verse 1]
+
+Regular line 1
+Regular line 2
+
+More content
+
+This is a very long line that exceeds forty characters for testing purposes
+This is another very long line that also exceeds the forty character limit
+Another very long line that should be considered too long for the slide
+And yet another very long line that should be split into a new section
+Regular line
+
+[verse 2]
+    First line with spaces    
+  Second line with spaces  
+[/verse 2]
+
+[chorus]`;
+
+console.log('Output from getSlideParts:');
+console.log(JSON.stringify(getSlideParts(comprehensiveInput), null, 2));

package/index.ts

@@ -1,2 +1,2 @@
-export * from './slide.js';
+export * from './slide.js';
 export * from './lyrics.js';

package/jest.config.js

@@ -1,17 +1,17 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-export default {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  transform: {
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        useESM: true,
-      },
-    ],
-  },
-};
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+};

package/lyrics.test.ts

@@ -1,76 +1,76 @@
-import { getLyricsParts } from './lyrics';
-
-const testLyrics = `[partname 1] (indication 1)
-
-content 1
-
-[/partname 1]
-
-[partname 1] (indication 2)
-
-[partname 2]
-
-content 2
-
-[/partname 2]
-
-[interlude 1]
-
-[partname 3]
-
-content without partname container
-
-content standalone 1
-content standalone 2
-`;
-
-describe('getLyricsParts', () => {
-  it('should correctly parse lyrics into parts', () => {
-    const result = getLyricsParts(testLyrics);
-
-    expect(result).toEqual([
-      {
-        name: 'partname 1',
-        repetition: false,
-        indication: 'indication 1',
-        content: 'content 1',
-      },
-      {
-        name: 'partname 1',
-        repetition: true,
-        indication: 'indication 2',
-        content: 'content 1',
-      },
-      {
-        name: 'partname 2',
-        repetition: false,
-        indication: null,
-        content: 'content 2',
-      },
-      {
-        name: 'interlude 1',
-        repetition: false,
-        indication: null,
-        content: undefined,
-      },
-      {
-        name: 'partname 3',
-        repetition: false,
-        indication: null,
-        content: undefined,
-      },
-      {
-        name: undefined,
-        repetition: false,
-        indication: null,
-        content: 'content without partname container',
-      },
-      {
-        name: undefined,
-        repetition: false,
-        indication: null,
-        content: 'content standalone 1\ncontent standalone 2',
-      },
-    ]);
-  });
-});
+import { getLyricsParts } from './lyrics';
+
+const testLyrics = `[partname 1] (indication 1)
+
+content 1
+
+[/partname 1]
+
+[partname 1] (indication 2)
+
+[partname 2]
+
+content 2
+
+[/partname 2]
+
+[interlude 1]
+
+[partname 3]
+
+content without partname container
+
+content standalone 1
+content standalone 2
+`;
+
+describe('getLyricsParts', () => {
+  it('should correctly parse lyrics into parts', () => {
+    const result = getLyricsParts(testLyrics);
+
+    expect(result).toEqual([
+      {
+        name: 'partname 1',
+        repetition: false,
+        indication: 'indication 1',
+        content: 'content 1',
+      },
+      {
+        name: 'partname 1',
+        repetition: true,
+        indication: 'indication 2',
+        content: 'content 1',
+      },
+      {
+        name: 'partname 2',
+        repetition: false,
+        indication: null,
+        content: 'content 2',
+      },
+      {
+        name: 'interlude 1',
+        repetition: false,
+        indication: null,
+        content: undefined,
+      },
+      {
+        name: 'partname 3',
+        repetition: false,
+        indication: null,
+        content: undefined,
+      },
+      {
+        name: undefined,
+        repetition: false,
+        indication: null,
+        content: 'content without partname container',
+      },
+      {
+        name: undefined,
+        repetition: false,
+        indication: null,
+        content: 'content standalone 1\ncontent standalone 2',
+      },
+    ]);
+  });
+});