Skip to content

Commit 435cd0a

Browse files
librazlibraz
committed
docs: add README, LICENSE, bilingual docs, and publish workflow
- Add Apache License 2.0 (LICENSE) - Add README.md (English) and README_ja.md (Japanese) with usage examples, capability matrix, and performance benchmarks - Add README.npm.md for npm package page - Add full bilingual documentation under docs/en/ and docs/ja/ covering CLI reference, JS/C++ API, constraints, examples, getting-started, introduction, and glossary - Add js/constraint.ts with fluent constraint builder (when().eq() .then().toString()) and matching tests in js/constraint.test.ts - Update js/index.ts and js/index.test.ts to expose constraint builder - Update src/wasm/bindings.cpp to support constraint evaluation from JS - Update package.json to set npm package metadata - Update .github/workflows/ci.yml: add Emscripten setup, granular ccache caching, parallel builds, skip CI for doc-only changes, and add concurrency group with cancel-in-progress - Add .github/workflows/publish.yml: tag-triggered release workflow that builds, tests, creates a GitHub Release, and publishes to npm - Update Makefile coverage target to suppress lcov noise and print summary inline
1 parent 3286ba0 commit 435cd0a

29 files changed

Lines changed: 5102 additions & 30 deletions

‎.github/workflows/ci.yml‎

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,21 @@ name: CI
33
on:
44
push:
55
branches: [main]
6+
tags-ignore: ['**']
7+
paths-ignore:
8+
- '**.md'
9+
- 'docs/**'
10+
- 'LICENSE'
611
pull_request:
712
branches: [main]
13+
paths-ignore:
14+
- '**.md'
15+
- 'docs/**'
16+
- 'LICENSE'
17+
18+
concurrency:
19+
group: ${{ github.workflow }}-${{ github.ref }}
20+
cancel-in-progress: true
821

922
jobs:
1023
lint:
@@ -19,40 +32,69 @@ jobs:
1932
runs-on: ubuntu-latest
2033
steps:
2134
- uses: actions/checkout@v4
22-
2335
- uses: volta-cli/action@v4
36+
- uses: mymindstorm/setup-emsdk@v14
2437

25-
- name: Setup ccache
26-
uses: hendrikmuhs/ccache-action@v1
38+
- name: Cache CMake dependencies
39+
uses: actions/cache@v4
2740
with:
28-
key: ${{ runner.os }}-ccache
41+
path: build/_deps
42+
key: ${{ runner.os }}-cmake-deps-${{ hashFiles('CMakeLists.txt', 'tests/CMakeLists.txt') }}
43+
restore-keys: |
44+
${{ runner.os }}-cmake-deps-
2945
30-
- name: Configure CMake
46+
- name: Cache ccache
47+
uses: actions/cache@v4
48+
with:
49+
path: ~/.cache/ccache
50+
key: ${{ runner.os }}-ccache-${{ github.sha }}
51+
restore-keys: |
52+
${{ runner.os }}-ccache-
53+
54+
- name: Install system dependencies
55+
run: |
56+
sudo apt-get update
57+
sudo apt-get install -y cmake build-essential lcov ccache
58+
59+
- name: Setup ccache
60+
run: |
61+
ccache --set-config=max_size=500M
62+
ccache --zero-stats
63+
64+
- name: Configure CMake with coverage
65+
env:
66+
CC: ccache gcc
67+
CXX: ccache g++
3168
run: |
3269
cmake -B build \
3370
-DCMAKE_BUILD_TYPE=Debug \
34-
-DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
71+
-DBUILD_TESTING=ON \
3572
-DENABLE_COVERAGE=ON
3673
3774
- name: Build C++
38-
run: cmake --build build -j
75+
run: cmake --build build --parallel
76+
77+
- name: Show ccache statistics
78+
run: ccache --show-stats
3979

4080
- name: Run C++ tests
41-
run: ctest --test-dir build --output-on-failure
81+
run: ctest --test-dir build --output-on-failure --parallel
4282

43-
- name: Coverage report
83+
- name: Generate coverage report
4484
run: |
45-
lcov --directory build --capture --output-file coverage.info
46-
lcov --extract coverage.info '*/src/*' --output-file coverage_filtered.info
85+
mkdir -p build/coverage
86+
lcov --directory build --capture --output-file build/coverage/coverage.info --ignore-errors source,gcov
87+
lcov --extract build/coverage/coverage.info "${PWD}/src/*" --output-file build/coverage/coverage_filtered.info --ignore-errors unused
4788
48-
- name: Upload coverage
89+
- name: Upload coverage to Codecov
4990
uses: codecov/codecov-action@v4
5091
with:
51-
files: coverage_filtered.info
92+
token: ${{ secrets.CODECOV_TOKEN }}
93+
files: ./build/coverage/coverage_filtered.info
94+
flags: unittests
95+
name: codecov-coverwise
5296
fail_ci_if_error: false
5397

54-
- name: Install JS dependencies
55-
run: yarn install --immutable
56-
57-
- name: TypeScript build
58-
run: yarn build:js
98+
- run: yarn install --immutable
99+
- run: yarn build
100+
- run: yarn test

‎.github/workflows/publish.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Publish and Create Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*.*.*'
7+
8+
permissions:
9+
contents: write
10+
id-token: write
11+
12+
jobs:
13+
publish:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: mymindstorm/setup-emsdk@v14
18+
- uses: volta-cli/action@v4
19+
20+
- uses: actions/cache@v4
21+
with:
22+
path: |
23+
.yarn/cache
24+
node_modules
25+
key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}
26+
restore-keys: |
27+
${{ runner.os }}-yarn-
28+
29+
- name: Build and test C++
30+
run: |
31+
cmake -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON
32+
cmake --build build --parallel
33+
ctest --test-dir build --output-on-failure
34+
35+
- run: yarn install --immutable
36+
- run: yarn build
37+
- run: yarn lint
38+
- run: yarn test
39+
40+
- name: Create GitHub Release
41+
uses: softprops/action-gh-release@v2
42+
with:
43+
name: Release ${{ github.ref_name }}
44+
tag_name: ${{ github.ref_name }}
45+
generate_release_notes: true
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
49+
- run: npm publish --access public
50+
env:
51+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎LICENSE‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to the Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by the Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding any notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2026 libraz
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

‎Makefile‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,18 @@ coverage-build:
3131
cmake -B $(BUILD_DIR) -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON
3232
cmake --build $(BUILD_DIR) -j
3333

34+
LCOV_IGNORE := --ignore-errors inconsistent,inconsistent,format,format,unused,unused,category,category,unsupported,unsupported
35+
3436
coverage: coverage-build
3537
@mkdir -p $(BUILD_DIR)/coverage
36-
cd $(BUILD_DIR) && lcov --directory . --zerocounters
38+
@cd $(BUILD_DIR) && lcov --directory . --zerocounters $(LCOV_IGNORE) >/dev/null 2>&1
3739
-cd $(BUILD_DIR) && ctest --output-on-failure --parallel
38-
cd $(BUILD_DIR) && lcov --directory . --capture --output-file coverage/coverage.info
39-
cd $(BUILD_DIR) && lcov --extract coverage/coverage.info '$(CURDIR)/src/*' --output-file coverage/coverage_filtered.info
40-
cd $(BUILD_DIR) && genhtml coverage/coverage_filtered.info --output-directory coverage/html
40+
@cd $(BUILD_DIR) && lcov --directory . --capture --output-file coverage/coverage.info $(LCOV_IGNORE) >/dev/null 2>&1
41+
@cd $(BUILD_DIR) && lcov --extract coverage/coverage.info '$(CURDIR)/src/*' --output-file coverage/coverage_filtered.info $(LCOV_IGNORE) >/dev/null 2>&1
42+
@cd $(BUILD_DIR) && genhtml coverage/coverage_filtered.info --output-directory coverage/html $(LCOV_IGNORE) >/dev/null 2>&1
43+
@echo ""
4144
@echo "Coverage report: $(BUILD_DIR)/coverage/html/index.html"
45+
@cd $(BUILD_DIR) && lcov --summary coverage/coverage_filtered.info $(LCOV_IGNORE) 2>&1 | grep -E 'lines|functions|source'
4246

4347
coverage-clean:
4448
find $(BUILD_DIR) -name '*.gcda' -delete 2>/dev/null || true

0 commit comments

Comments
 (0)