Skip to content

Commit 9388a51

Browse files
committed
style: apply prettier formatting fixes
Issue: - CI linter failing with 188 formatting errors - Files not properly formatted after previous commits - Prettier configured via eslint-config-prettier Fix: - Run 'pnpm run format' to apply prettier formatting - Auto-fix all indentation and spacing issues - Ensure code style consistency Files affected: - spec/v1.2/README.md (primary formatting issues) - Other files with minor whitespace fixes Testing: - pnpm run format:check passes locally - pnpm run lint:check passes locally - No functional changes to code Refs: CI lint failure in run #18589287932
1 parent b52f643 commit 9388a51

File tree

18 files changed

+323
-244
lines changed

18 files changed

+323
-244
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,24 @@
33
All notable changes to OmniScript Format will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
and this project adheres to
7+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
78

89
---
910

1011
## [1.2.0] - 2025-10-16
1112

1213
### πŸŽ‰ Major Release - Tables, Includes & Enterprise Security
1314

14-
This is a major feature release bringing tables, file composition, and comprehensive security hardening.
15+
This is a major feature release bringing tables, file composition, and
16+
comprehensive security hardening.
1517

1618
### Added
1719

1820
#### Features
19-
- **@table blocks** - Markdown-style tables with captions, alignment, and styling
21+
22+
- **@table blocks** - Markdown-style tables with captions, alignment, and
23+
styling
2024
- Pipe syntax (`| Header | Header |`)
2125
- Column alignment (left, center, right)
2226
- Optional captions and style variants
@@ -38,6 +42,7 @@ This is a major feature release bringing tables, file composition, and comprehen
3842
- Edge case tests
3943

4044
#### Architecture
45+
4146
- **Refactored parser** - 904 lines β†’ 173 lines (81% reduction)
4247
- Split into lexer, block-parsers, serializers, utils
4348
- 25 focused modules
@@ -50,6 +55,7 @@ This is a major feature release bringing tables, file composition, and comprehen
5055
- Runtime checks (tertiary)
5156

5257
#### Testing
58+
5359
- 70% increase in test coverage (56 β†’ 130 tests)
5460
- Parser: 64 β†’ 83 tests (+19 security tests)
5561
- CLI: 42 β†’ 47 tests (+5 table rendering tests)
@@ -58,25 +64,30 @@ This is a major feature release bringing tables, file composition, and comprehen
5864
### Changed
5965

6066
#### Security Improvements
67+
6168
- **Path validation** - Prevents directory escape attacks
62-
- **Regex bounds** - Prevents ReDoS with bounded quantifiers (`\s{0,20}` vs `\s*`)
69+
- **Regex bounds** - Prevents ReDoS with bounded quantifiers (`\s{0,20}` vs
70+
`\s*`)
6371
- **Input validation** - All inputs validated at multiple layers
6472
- **Error messages** - More contextual, helpful debugging information
6573
- **Number parsing** - Validates against NaN and Infinity
6674

6775
#### Code Quality
76+
6877
- Zero `any` types throughout codebase
6978
- TypeScript strict mode with `exactOptionalPropertyTypes`
7079
- All files under 300 lines (maintainability)
7180
- Comprehensive JSDoc documentation
7281

7382
#### Developer Experience
83+
7484
- Better error messages with line/column info
7585
- Clear validation failures
7686
- Improved type inference
7787
- Enhanced IntelliSense support
7888

7989
### Fixed
90+
8091
- [P1] Path traversal vulnerability in @include
8192
- [P1] Unsafe basePath default (browser compatibility)
8293
- [P1] No alignment validation in @table
@@ -87,42 +98,49 @@ This is a major feature release bringing tables, file composition, and comprehen
8798
- [P2] Weak error messages (added context)
8899

89100
### Security
101+
90102
- **Grade**: C+ β†’ A+
91103
- **Vulnerabilities Fixed**: 8 (5 P1, 3 P2)
92104
- **Security Tests**: 0 β†’ 19
93105
- **Audit**: Full staff engineer-level P# review
94106

95107
### Performance
108+
96109
- No performance degradation
97110
- Validation overhead: <1ms per document
98111
- Build times unchanged (<5s)
99112
- Test times: <30s for 130 tests
100113

101114
### Breaking Changes
115+
102116
- **None** - Fully backward compatible with v1.0 and v1.1
103117

104118
---
105119

106120
## [1.1.0] - 2025-10-XX
107121

108122
### Added
123+
109124
- Strikethrough text support (`~~text~~`)
110125
- Unicode escape sequences (`\uXXXX`, `\xXX`)
111126
- Line:column error tracking
112127
- Extended HTML rendering (ordered lists, blockquotes, code, images)
113128
- Enhanced Markdown export
114129

115130
### Security
131+
116132
- HTML escaping to prevent XSS attacks
117133

118134
### Changed
135+
119136
- 56 tests passing (all new features covered)
120137

121138
---
122139

123140
## [1.0.0] - 2025-10-XX
124141

125142
### Added
143+
126144
- Initial production release
127145
- Core block types: @meta, @doc, @slide, @sheet
128146
- Advanced blocks: @chart, @diagram, @code
@@ -137,6 +155,7 @@ This is a major feature release bringing tables, file composition, and comprehen
137155
## [0.6.0] - 2025-10-XX
138156

139157
### Added
158+
140159
- Beta release with core functionality
141160
- Parser engine
142161
- Basic converters
@@ -147,6 +166,7 @@ This is a major feature release bringing tables, file composition, and comprehen
147166
## [0.5.0] - 2025-10-XX
148167

149168
### Added
169+
150170
- Initial alpha release
151171
- Proof of concept
152172
- Basic parsing

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ Write examples and test documents βœ… Improve documentation, READMEs, and guides
9494

9595
### Commit Message Convention
9696

97-
We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
97+
We follow the [Conventional Commits](https://www.conventionalcommits.org/)
98+
specification:
9899

99100
- `feat:` - A new feature
100101
- `fix:` - A bug fix
@@ -107,6 +108,7 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/) speci
107108
- `ci:` - CI/CD configuration changes
108109

109110
**Examples:**
111+
110112
```
111113
feat: add @diagram block support
112114
fix: handle nested bullets in slides properly
@@ -119,7 +121,8 @@ test: add tests for formula parsing
119121
- **TypeScript**: Use strict mode with proper type annotations
120122
- **Formatting**: Automatically handled by Prettier (run `pnpm run format`)
121123
- **Linting**: Follow ESLint rules (run `pnpm run lint`)
122-
- **Naming**: Use camelCase for variables/functions, PascalCase for classes/types
124+
- **Naming**: Use camelCase for variables/functions, PascalCase for
125+
classes/types
123126

124127
### Testing Requirements
125128

@@ -220,7 +223,8 @@ node index.js parse ../../examples/rich_demo.osf
220223
### Getting Help
221224

222225
- πŸ“– Read the [documentation](docs/spec-v0.5-overview.md)
223-
- πŸ’¬ Ask in [GitHub Discussions](https://github.com/OmniScriptOSF/omniscript-core/discussions)
226+
- πŸ’¬ Ask in
227+
[GitHub Discussions](https://github.com/OmniScriptOSF/omniscript-core/discussions)
224228
- πŸ› Report issues using [issue templates](.github/ISSUE_TEMPLATE/)
225229
- πŸ“§ Contact maintainer: [@alpha912](https://github.com/alpha912)
226230

0 commit comments

Comments
Β (0)