chord-progression-parser 0.7.0

a converter from chord progression strings to AST
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

check-not-broken:
	bun i
	make generate-error-code-rs
	make check-lint
	make check-build
	make build-wasm-web
	make build-wasm-node
	make build-wasm-bundler
	make modify-package-name-web
	make modify-package-name-node
	make modify-package-name-bundler
	make prepare-test
	make test-rust
	make test-resources
	make test-e2e
	make test-generator

check-local:
	make check-lint
	make check-build
	make test-rust
	make test-resources

################################################################
################################################################ common 
################################################################

# install
install:
	rustup target add wasm32-unknown-unknown
	rustup component add rustfmt clippy
	cargo install typeshare-cli
	cargo install cargo-insta
	bun i
	bun lefthook install

# run
run:
	cargo run

# build
build:
	cargo build

# clean
clean:
	cargo clean

# build wasm for web (use for browser javascript without any bundler?)
build-wasm-web:
	wasm-pack build \
		--release \
		--scope lainnao \
		--out-dir ./pkg/pkg-web \
		--target web
	make generate-ts-declare-file-for-pkg-web

# modify package-name
# append "-web" to package json "name" field
modify-package-name-web:
	cd pkg/pkg-web && npx change-package-name @lainnao\/chord-progression-parser-web && bun i

# build wasm for node (use for server javascript without any bundler?)
build-wasm-node:
	wasm-pack build \
		--release \
		--scope lainnao \
		--out-dir ./pkg/pkg-node \
		--target nodejs
	make generate-ts-declare-file-for-pkg-node

# modify package-name
# append "-node" to package json "name" field
modify-package-name-node:
	cd pkg/pkg-node && npx change-package-name @lainnao\/chord-progression-parser-node && bun i

# build wasm for bundler (use for server/client javascript with bundler?)
build-wasm-bundler:
	wasm-pack build \
		--release \
		--scope lainnao \
		--out-dir ./pkg/pkg-bundler \
		--target bundler
	make generate-ts-declare-file-for-pkg-bundler
	make add-package-json-type-module-for-pkg-bundler

# modify package-name
# append "-bundler" to package json "name" field
modify-package-name-bundler:
	cd pkg/pkg-bundler && npx change-package-name @lainnao\/chord-progression-parser-bundler && bun i

################################################################
################################################################ generator 
################################################################

# generate src/error_code.rs
generate-error-code-rs:
	bun resources/error_code_message_map.util.ts

# generate and modify d.ts
# HACK: this is not good way. do it by wasm_bindgen directly
# NOTE: dependes on build-wasm-web
generate-ts-declare-file-for-pkg-web:
	make generate-ts-types
# Rewrite definition of return value of run function in pkg-web/chord_progression_parser.d.ts to "Ast"
	sed -i.bak 's/any/ParsedResult/g' pkg/pkg-web/chord_progression_parser.d.ts && rm pkg/pkg-web/chord_progression_parser.d.ts.bak
# compile additinal files
	npx tsc resources/error_code_message_map.ts --declaration --allowJs --module CommonJS --outDir pkg/pkg-web
	npx tsc resources/generatedTypes.ts --declaration --allowJs --module CommonJS --outDir pkg/pkg-web
# add to package.json "files"
	sed -i.bak 's/"files": \[/"files": \[\
		"error_code_message_map.js", "error_code_message_map.d.ts",/g' pkg/pkg-web/package.json && rm pkg/pkg-web/package.json.bak
	sed -i.bak 's/"files": \[/"files": \[\
		"generatedTypes.js", "generatedTypes.ts", "generatedTypes.d.ts",/g' pkg/pkg-web/package.json && rm pkg/pkg-web/package.json.bak
# prepend contents of additionalType.ts.txt to pkg/pkg-web/chord_progression_parser.d.ts
	cat resources/additionalType.ts.txt pkg/pkg-web/chord_progression_parser.d.ts > pkg/pkg-web/chord_progression_parser.d.ts.tmp && mv pkg/pkg-web/chord_progression_parser.d.ts.tmp pkg/pkg-web/chord_progression_parser.d.ts

# generate and modify d.ts
# HACK: this is not good way. do it by wasm_bindgen directly
# NOTE: dependes on build-wasm-node
generate-ts-declare-file-for-pkg-node:
	make generate-ts-types
# Rewrite definition of return value of run function in pkg-node/chord_progression_parser.d.ts to "Ast"
	sed -i.bak 's/any/ParsedResult/g' pkg/pkg-node/chord_progression_parser.d.ts && rm pkg/pkg-node/chord_progression_parser.d.ts.bak
# compile additinal files
	npx tsc resources/error_code_message_map.ts --declaration --allowJs --module CommonJS --outDir pkg/pkg-node
	npx tsc resources/generatedTypes.ts --declaration --allowJs --module CommonJS --outDir pkg/pkg-node
# add to package.json "files"
	sed -i.bak 's/"files": \[/"files": \[\
		"error_code_message_map.js", "error_code_message_map.d.ts",/g' pkg/pkg-node/package.json && rm pkg/pkg-node/package.json.bak
	sed -i.bak 's/"files": \[/"files": \[\
		"generatedTypes.js", "generatedTypes.ts", "generatedTypes.d.ts",/g' pkg/pkg-node/package.json && rm pkg/pkg-node/package.json.bak
# prepend contents of additionalType.ts.txt to pkg/pkg-node/chord_progression_parser.d.ts
	cat resources/additionalType.ts.txt pkg/pkg-node/chord_progression_parser.d.ts > pkg/pkg-node/chord_progression_parser.d.ts.tmp && mv pkg/pkg-node/chord_progression_parser.d.ts.tmp pkg/pkg-node/chord_progression_parser.d.ts

# generate and modify d.ts
# HACK: this is not good way. do it by wasm_bindgen directly
# NOTE: dependes on build-wasm-bundler
generate-ts-declare-file-for-pkg-bundler:
	make generate-ts-types
# Rewrite definition of return value of run function in pkg-bundler/chord_progression_parser.d.ts to "Ast"
	sed -i.bak 's/any/ParsedResult/g' pkg/pkg-bundler/chord_progression_parser.d.ts && rm pkg/pkg-bundler/chord_progression_parser.d.ts.bak
# compile additinal files
	npx tsc resources/error_code_message_map.ts --declaration --allowJs --module NodeNext --moduleResolution nodenext --outDir pkg/pkg-bundler
	npx tsc resources/generatedTypes.ts --declaration --allowJs --module NodeNext --moduleResolution nodenext --outDir pkg/pkg-bundler
# add to package.json "files"
	sed -i.bak 's/"files": \[/"files": \[\
		"error_code_message_map.js", "error_code_message_map.d.ts", /g' pkg/pkg-bundler/package.json && rm pkg/pkg-bundler/package.json.bak
	sed -i.bak 's/"files": \[/"files": \[\
		"generatedTypes.js", "generatedTypes.ts", "generatedTypes.d.ts",/g' pkg/pkg-bundler/package.json && rm pkg/pkg-bundler/package.json.bak
# prepend contents of additionalType.ts.txt to pkg/pkg-bundler/chord_progression_parser.d.ts
	cat resources/additionalType.ts.txt pkg/pkg-bundler/chord_progression_parser.d.ts > pkg/pkg-bundler/chord_progression_parser.d.ts.tmp && mv pkg/pkg-bundler/chord_progression_parser.d.ts.tmp pkg/pkg-bundler/chord_progression_parser.d.ts

# add package.json type module
add-package-json-type-module-for-pkg-bundler:
	sed -i.bak 's/"name": "\(.*\)"/"name": "\1",\n  "type": "module"/' pkg/pkg-bundler/package.json && rm pkg/pkg-bundler/package.json.bak

# generate types
generate-ts-types:
	typeshare ./src \
		--lang=typescript \
		--output-file=resources/generatedTypes.ts
	bun resources/fix_generated_types.ts

################################################################
################################################################ fixer 
################################################################

# format
fmt:
	cargo fmt

# fix
fix:
	cargo fix

################################################################
################################################################ tester 
################################################################

# preparet est
prepare-test:
# HACK: remove dependencies from package.json
#       → error: Package "@lainnao/chord-progression-parser-node@0.4.2" has a dependency loop
	cd e2e-test/node && sed -i.bak '/chord-progression-parser/d' package.json && rm package.json.bak
	cd e2e-test/bundler && sed -i.bak '/chord-progression-parser/d' package.json && rm package.json.bak
	cd e2e-test/web && sed -i.bak '/chord-progression-parser/d' package.json && rm package.json.bak
# install
	cd e2e-test/node && bun add ../../pkg/pkg-node 
	cd e2e-test/bundler &&  bun add ../../pkg/pkg-bundler
	cd e2e-test/web && bun add ../../pkg/pkg-web

# review snapshot
# use it when you want to update snapshot and pass snapshot test
review-snapshot:
	cargo insta review

# lint check
check-lint:
	cargo clippy --all-targets --all-features -- -D warnings
	cargo fmt --all -- --check

# build check
check-build:
	cargo check

# unit & integration test
test-rust:
	cargo test --all-targets --all-features

# e2e test
test-e2e:
	cd e2e-test/node && bun run test
	cd e2e-test/bundler && npx playwright install --with-deps && bun run test
	make run-web-e2e

# generator test
test-generator:
	cd _tools/chord-progression-generator && bun i && bun run test

# e2e test of web
run-web-e2e:
# copy pkg-web to e2e-test/web/generated-src, by overrite
	rm -rf ./e2e-test/web/generated-src && cp -r ./pkg/pkg-web ./e2e-test/web/generated-src
# copy e2e-test/web/originl.index.html to e2e-test/web/src/index.html
	cp ./e2e-test/web/original.index.html ./e2e-test/web/generated-src/index.html
# test
	cd ./e2e-test/web && npx playwright install --with-deps && bun run test

# test resources
test-resources:
	cd resources && bun test

################################################################
################################################################ util 
################################################################

# see doc
doc:
	cargo doc --open

# see coverage
see-coverage:
	cargo llvm-cov --show-missing-lines --open

# needs: "chmod +x _tools/find_files_include_multibyte_characters.sh"
find-multibyte:
	./_tools/find_files_include_multibyte_characters.sh