diff --git a/.github/workflows/ghc.yml b/.github/workflows/ghc.yml index 88c7f3ad8..49505bd01 100644 --- a/.github/workflows/ghc.yml +++ b/.github/workflows/ghc.yml @@ -198,7 +198,7 @@ jobs: shell: bash env: PIPELINE_LOCK_CHANGED: ${{ (steps.check-pipeline-lock.outputs.PIPELINE_LOCK_CHANGED == 'true') || (steps.pipeline-files.outputs.cache-hit != 'true') }} - NORMALIZER_INSTALLED: "true" + EO_PHI_NORMALIZER_INSTALLED: "true" run: ./scripts/pipeline.sh - name: Check failing tests @@ -233,12 +233,12 @@ jobs: source scripts/lib.sh commit_and_push_if_changed "$PIPELINE_LOCK_FILE_RELATIVE" "$PIPELINE_LOCK_FILE_RELATIVE" - - name: Commit and push changes in normalizer data files + - name: Commit and push changes in eo-phi-normalizer data files if: always() && env.branch_is_not_master && runner.os == 'Linux' run: | source scripts/lib.sh - data_directory="$PIPELINE_NORMALIZER_DATA_DIR" - commit_and_push_if_changed "$data_directory" "normalizer data files" + data_directory="$PIPELINE_EO_PHI_NORMALIZER_DATA_DIR" + commit_and_push_if_changed "$data_directory" "eo-phi-normalizer data files" - name: Install mdsh if: env.branch_is_not_master && runner.os == 'Linux' diff --git a/README.md b/README.md index 137bb06da..79007cb91 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Normalizer for 𝜑-calculus [![`eo-phi-normalizer` on Hackage](https://img.shields.io/hackage/v/eo-phi-normalizer)](http://hackage.haskell.org/package/eo-phi-normalizer) -[![Haddock]()](https://www.objectionary.com/normalizer/haddock/) +[![Haddock]()](https://www.objectionary.com/eo-phi-normalizer/haddock/) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.txt) -[![Hits-of-Code](https://hitsofcode.com/github/objectionary/normalizer?branch=master&label=Hits-of-Code)](https://hitsofcode.com/github/objectionary/normalizer/view?branch=master&label=Hits-of-Code) -![Lines of code](https://sloc.xyz/github/objectionary/normalizer) +[![Hits-of-Code](https://hitsofcode.com/github/objectionary/eo-phi-normalizer?branch=master&label=Hits-of-Code)](https://hitsofcode.com/github/objectionary/eo-phi-normalizer/view?branch=master&label=Hits-of-Code) +![Lines of code](https://sloc.xyz/github/objectionary/eo-phi-normalizer) Command line normalizer of 𝜑-calculus expressions (as produced by the [EO compiler](https://github.com/objectionary/eo)). -Consult the [project documentation](https://www.objectionary.com/normalizer/) for more details. +Consult the [project documentation](https://www.objectionary.com/eo-phi-normalizer/) for more details. diff --git a/eo-phi-normalizer/CHANGELOG.md b/eo-phi-normalizer/CHANGELOG.md index 13a1426a1..d1e4b87c3 100644 --- a/eo-phi-normalizer/CHANGELOG.md +++ b/eo-phi-normalizer/CHANGELOG.md @@ -10,67 +10,67 @@ and this project adheres to the ### New -- Add unit tests [#461](https://github.com/objectionary/normalizer/pull/461) -- Add `R_DOT_ρ` [#468](https://github.com/objectionary/normalizer/pull/468) -- Support printing rules in LaTeX [#474](https://github.com/objectionary/normalizer/pull/474) -- Automatically create an output directory [#499](https://github.com/objectionary/normalizer/pull/499) +- Add unit tests [#461](https://github.com/objectionary/eo-phi-normalizer/pull/461) +- Add `R_DOT_ρ` [#468](https://github.com/objectionary/eo-phi-normalizer/pull/468) +- Support printing rules in LaTeX [#474](https://github.com/objectionary/eo-phi-normalizer/pull/474) +- Automatically create an output directory [#499](https://github.com/objectionary/eo-phi-normalizer/pull/499) ### Changes and fixes -- Update the `COPY` rule as in phi-paper [#445](https://github.com/objectionary/normalizer/pull/445) -- Remove special case for delta binding since VTX is removed [#356](https://github.com/objectionary/normalizer/pull/356) -- Replace `normalizer report` command with the `normalizer pipeline report` command [#456](https://github.com/objectionary/normalizer/pull/456) -- Fix sorting in numeric columns [#460](https://github.com/objectionary/normalizer/pull/460) -- Run mdbook in the pipeline job [#463](https://github.com/objectionary/normalizer/pull/463) +- Update the `COPY` rule as in phi-paper [#445](https://github.com/objectionary/eo-phi-normalizer/pull/445) +- Remove special case for delta binding since VTX is removed [#356](https://github.com/objectionary/eo-phi-normalizer/pull/356) +- Replace `normalizer report` command with the `normalizer pipeline report` command [#456](https://github.com/objectionary/eo-phi-normalizer/pull/456) +- Fix sorting in numeric columns [#460](https://github.com/objectionary/eo-phi-normalizer/pull/460) +- Run mdbook in the pipeline job [#463](https://github.com/objectionary/eo-phi-normalizer/pull/463) ### Documentation and maintenance -- Document all dependencies in a single doc in `eo/phi/normalizer/data` for each eo version [#446](https://github.com/objectionary/normalizer/pull/446). -- Create a metrics page on the site [#453](https://github.com/objectionary/normalizer/pull/453) -- Chore(deps): update dependency pre-commit to v3.8.0 [#455](https://github.com/objectionary/normalizer/pull/455) -- Provide instructions for the customer to check that we've completed the contract requirements [#458](https://github.com/objectionary/normalizer/pull/458) -- Bump stack action version [#459](https://github.com/objectionary/normalizer/pull/459) -- Update proposal process [#464](https://github.com/objectionary/normalizer/pull/464) -- Document creating custom atoms on the site [#467](https://github.com/objectionary/normalizer/pull/467) +- Document all dependencies in a single doc in `eo/phi/normalizer/data` for each eo version [#446](https://github.com/objectionary/eo-phi-normalizer/pull/446). +- Create a metrics page on the site [#453](https://github.com/objectionary/eo-phi-normalizer/pull/453) +- Chore(deps): update dependency pre-commit to v3.8.0 [#455](https://github.com/objectionary/eo-phi-normalizer/pull/455) +- Provide instructions for the customer to check that we've completed the contract requirements [#458](https://github.com/objectionary/eo-phi-normalizer/pull/458) +- Bump stack action version [#459](https://github.com/objectionary/eo-phi-normalizer/pull/459) +- Update proposal process [#464](https://github.com/objectionary/eo-phi-normalizer/pull/464) +- Document creating custom atoms on the site [#467](https://github.com/objectionary/eo-phi-normalizer/pull/467) ## v1.0.0 - 2024-07-19 ### New -- Align reductions from application to `⊥` with the paper ([#418](https://github.com/objectionary/normalizer/pull/418), [#435](https://github.com/objectionary/normalizer/pull/435)) -- Support enabling/disabling particular atoms ([#426](https://github.com/objectionary/normalizer/pull/426)) -- Support custom rules ([#432](https://github.com/objectionary/normalizer/pull/432)) - - Test ruleset `streams.yaml` with the example rule equipped with a passing test, matching +- Align reductions from application to `⊥` with the paper ([#418](https://github.com/objectionary/eo-phi-normalizer/pull/418), [#435](https://github.com/objectionary/eo-phi-normalizer/pull/435)) +- Support enabling/disabling particular atoms ([#426](https://github.com/objectionary/eo-phi-normalizer/pull/426)) +- Support custom rules ([#432](https://github.com/objectionary/eo-phi-normalizer/pull/432)) + - Test ruleset `streams.yaml` with the example rule equipped with a passing test, matching - Allow rules to go inside abstract objects (and add explicit `apply_in_abstract_subformations` option to maintain correctness for `yegor.yaml` rules) - Support tail patterns (restricted one-hole contexts) - Matching against objects inside dispatch - Matching against objects inside application (left only) - Properly generate fresh names - - Allow explicit `forall` to keep track of all metavariables for extra safety (force in the future, see [#441](https://github.com/objectionary/normalizer/issues/441)). + - Allow explicit `forall` to keep track of all metavariables for extra safety (force in the future, see [#441](https://github.com/objectionary/eo-phi-normalizer/issues/441)). - Distinguish types of metavariables for extra safety. ### Changes and fixes -- Update decoration rule ([#420](https://github.com/objectionary/normalizer/pull/420)) -- Generalize `Φ-dispatch` to rewrite `Φ` instead of `Φ.a` ([#419](https://github.com/objectionary/normalizer/pull/419)) +- Update decoration rule ([#420](https://github.com/objectionary/eo-phi-normalizer/pull/420)) +- Generalize `Φ-dispatch` to rewrite `Φ` instead of `Φ.a` ([#419](https://github.com/objectionary/eo-phi-normalizer/pull/419)) ### Documentation and maintenance -- Update EO to 0.38.4 ([#426](https://github.com/objectionary/normalizer/pull/426)) +- Update EO to 0.38.4 ([#426](https://github.com/objectionary/eo-phi-normalizer/pull/426)) ## v0.4.1 — 2024-06-12 Changes and fixes: -- Undo injection of top-level Package lambda ([#392](https://github.com/objectionary/normalizer/pull/392)) -- Fix dataization ([#395](https://github.com/objectionary/normalizer/pull/395)) - - Fix dataization inside $\varphi$ when `--minimize-stuck-terms` is enabled (closes [#393](https://github.com/objectionary/normalizer/pull/393)) +- Undo injection of top-level Package lambda ([#392](https://github.com/objectionary/eo-phi-normalizer/pull/392)) +- Fix dataization ([#395](https://github.com/objectionary/eo-phi-normalizer/pull/395)) + - Fix dataization inside $\varphi$ when `--minimize-stuck-terms` is enabled (closes [#393](https://github.com/objectionary/eo-phi-normalizer/pull/393)) - Fix evaluation of atoms stuck on other atoms (fixes `while-dataizes-only-first-cycle` in `while-tests.phi`) - - Improve pretty-printing (closes [#292](https://github.com/objectionary/normalizer/pull/292)) + - Improve pretty-printing (closes [#292](https://github.com/objectionary/eo-phi-normalizer/pull/292)) -- Fix pipeline script to run tests on normalized EO ([#396](https://github.com/objectionary/normalizer/pull/396)) +- Fix pipeline script to run tests on normalized EO ([#396](https://github.com/objectionary/eo-phi-normalizer/pull/396)) -- Changes to normalizer ([#396](https://github.com/objectionary/normalizer/pull/396)) +- Changes to normalizer ([#396](https://github.com/objectionary/eo-phi-normalizer/pull/396)) - Add `--wrap-raw-bytes` to automatically convert raw bytes (and terminations) in the output. This is a temporary fix, pending the change mentioned in - Fix builtin normalizer to produce termination in some situations - Fix dataization inside application/dispatch @@ -82,13 +82,13 @@ Changes and fixes: - Support up to 3 positional arguments in the builtin normalizer - Fix directory used in CI for: - - Job summary ([#402](https://github.com/objectionary/normalizer/pull/402)) - - Report ([#412](https://github.com/objectionary/normalizer/pull/412)) + - Job summary ([#402](https://github.com/objectionary/eo-phi-normalizer/pull/402)) + - Report ([#412](https://github.com/objectionary/eo-phi-normalizer/pull/412)) Documentation and maintenance: -- Bring rules up to date ([#401](https://github.com/objectionary/normalizer/pull/401)) -- Update dependency prettier to v3.3.2 ([#385](https://github.com/objectionary/normalizer/pull/385)) +- Bring rules up to date ([#401](https://github.com/objectionary/eo-phi-normalizer/pull/401)) +- Update dependency prettier to v3.3.2 ([#385](https://github.com/objectionary/eo-phi-normalizer/pull/385)) ## v0.4.0 — 2024-06-03 @@ -97,26 +97,26 @@ This version supports fast dataization with built-in rules and improves metrics New: - Add built-in rules -- Add more built-in dataization functions ([#291](https://github.com/objectionary/normalizer/pull/291)) -- Support LaTeX format in output ([#308](https://github.com/objectionary/normalizer/pull/308)) -- Speed up pipeline by caching EO compilation results ([#340](https://github.com/objectionary/normalizer/pull/340)) -- Write generated PHI files as eo-phi-normalizer data files ([#286](https://github.com/objectionary/normalizer/pull/286)) -- Update and commit docs in CI ([#286](https://github.com/objectionary/normalizer/pull/286)) +- Add more built-in dataization functions ([#291](https://github.com/objectionary/eo-phi-normalizer/pull/291)) +- Support LaTeX format in output ([#308](https://github.com/objectionary/eo-phi-normalizer/pull/308)) +- Speed up pipeline by caching EO compilation results ([#340](https://github.com/objectionary/eo-phi-normalizer/pull/340)) +- Write generated PHI files as eo-phi-normalizer data files ([#286](https://github.com/objectionary/eo-phi-normalizer/pull/286)) +- Update and commit docs in CI ([#286](https://github.com/objectionary/eo-phi-normalizer/pull/286)) Changes and fixes: -- Switch to EO 0.38.0 ([#335](https://github.com/objectionary/normalizer/pull/335)) -- Remove VTX and Sigma ([#335](https://github.com/objectionary/normalizer/pull/335)) -- Fix normalization and dataization rules w.r.t. xi and rho (see [#297](https://github.com/objectionary/normalizer/pull/297)) -- Fix confluence tests ([#319](https://github.com/objectionary/normalizer/pull/319)) -- Fix pipeline tests ([#338](https://github.com/objectionary/normalizer/pull/338)) -- Integrate `transform-eo-tests` into normalizer ([#365](https://github.com/objectionary/normalizer/pull/365)) -- Switch to GHC 9.6.4 ([#263](https://github.com/objectionary/normalizer/pull/263)) +- Switch to EO 0.38.0 ([#335](https://github.com/objectionary/eo-phi-normalizer/pull/335)) +- Remove VTX and Sigma ([#335](https://github.com/objectionary/eo-phi-normalizer/pull/335)) +- Fix normalization and dataization rules w.r.t. xi and rho (see [#297](https://github.com/objectionary/eo-phi-normalizer/pull/297)) +- Fix confluence tests ([#319](https://github.com/objectionary/eo-phi-normalizer/pull/319)) +- Fix pipeline tests ([#338](https://github.com/objectionary/eo-phi-normalizer/pull/338)) +- Integrate `transform-eo-tests` into normalizer ([#365](https://github.com/objectionary/eo-phi-normalizer/pull/365)) +- Switch to GHC 9.6.4 ([#263](https://github.com/objectionary/eo-phi-normalizer/pull/263)) Documentation and maintenance: -- Add the `Quick Start` page ([#317](https://github.com/objectionary/normalizer/pull/317)) -- Add the `Pipeline` page ([#261](https://github.com/objectionary/normalizer/pull/261)) +- Add the `Quick Start` page ([#317](https://github.com/objectionary/eo-phi-normalizer/pull/317)) +- Add the `Pipeline` page ([#261](https://github.com/objectionary/eo-phi-normalizer/pull/261)) ## v0.3.1 — 2024-04-12 @@ -124,22 +124,22 @@ This version supports proper dataization of test programs with dependencies. New: -- Add `--dependency-file FILE` option to enable dependencies (e.g. `bool.phi`, `bytes.phi`) (see [#265](https://github.com/objectionary/normalizer/pull/265)) +- Add `--dependency-file FILE` option to enable dependencies (e.g. `bool.phi`, `bytes.phi`) (see [#265](https://github.com/objectionary/eo-phi-normalizer/pull/265)) Changes and fixes: -- Fix handling of `Package` atom (also improves related code, see [#239](https://github.com/objectionary/normalizer/pull/239) and [#265](https://github.com/objectionary/normalizer/pull/265)) -- Update the dataless objects metric (see [#234](https://github.com/objectionary/normalizer/pull/234)) -- Improve reports (see [#225](https://github.com/objectionary/normalizer/pull/225)) +- Fix handling of `Package` atom (also improves related code, see [#239](https://github.com/objectionary/eo-phi-normalizer/pull/239) and [#265](https://github.com/objectionary/eo-phi-normalizer/pull/265)) +- Update the dataless objects metric (see [#234](https://github.com/objectionary/eo-phi-normalizer/pull/234)) +- Improve reports (see [#225](https://github.com/objectionary/eo-phi-normalizer/pull/225)) Documentation and maintenance: -- Establish proposals format and process (see [#248](https://github.com/objectionary/normalizer/pull/248)) -- Improve the docs job, improve the site, fix minor errors (see [#228](https://github.com/objectionary/normalizer/pull/228)) -- Fix `hlint` warnings (see [#241](https://github.com/objectionary/normalizer/pull/241)) -- CI: run doctests (see [#230](https://github.com/objectionary/normalizer/pull/230)) -- CI: switch back to the official `stack-action` (see [#246](https://github.com/objectionary/normalizer/pull/246)) -- CI: publish extra files in artifacts (in particular, dependencies like `bool.phi`, see [#245](https://github.com/objectionary/normalizer/pull/245)) +- Establish proposals format and process (see [#248](https://github.com/objectionary/eo-phi-normalizer/pull/248)) +- Improve the docs job, improve the site, fix minor errors (see [#228](https://github.com/objectionary/eo-phi-normalizer/pull/228)) +- Fix `hlint` warnings (see [#241](https://github.com/objectionary/eo-phi-normalizer/pull/241)) +- CI: run doctests (see [#230](https://github.com/objectionary/eo-phi-normalizer/pull/230)) +- CI: switch back to the official `stack-action` (see [#246](https://github.com/objectionary/eo-phi-normalizer/pull/246)) +- CI: publish extra files in artifacts (in particular, dependencies like `bool.phi`, see [#245](https://github.com/objectionary/eo-phi-normalizer/pull/245)) ## v0.3.0 — 2024-03-26 @@ -152,44 +152,44 @@ New: - Command Line Interface: - Add commands: - `normalizer transform` to perform normalization without executing any atoms (was default behavior before) - - `normalizer metrics` to compute metrics of a given φ-expression (see [#153](https://github.com/objectionary/normalizer/pull/153)) - - `normalizer dataize` to run partial evaluation of φ-expressions with atoms (see [#187](https://github.com/objectionary/normalizer/pull/187)) - - `normalizer report` to generate report based on the results of testing against the EO compiler (see [#213](https://github.com/objectionary/normalizer/pull/213)) - - Add `--single` flag (see [#131](https://github.com/objectionary/normalizer/pull/131)) - - Add `--json` flag for machine-readable output format (see [#143](https://github.com/objectionary/normalizer/pull/143)) - - Add `--max-depth=N` and `--max-term-size=N` options to control limits for the normalizer (see [#173](https://github.com/objectionary/normalizer/pull/173)) - - Improve `--chain` option to provide better elaboration on the applied normalization rules and the dataization process (see [#195](https://github.com/objectionary/normalizer/pull/195)) -- Update rule set for φ-calculus (see [#152](https://github.com/objectionary/normalizer/pull/152) and some changes in [#136](https://github.com/objectionary/normalizer/pull/136) and [#166](https://github.com/objectionary/normalizer/pull/166)) -- Add property-based and regression tests for confluence (see [#136](https://github.com/objectionary/normalizer/pull/136) and [#166](https://github.com/objectionary/normalizer/pull/166)) -- Tests and metrics against the EO compiler and standard EO test suite (see [#98](https://github.com/objectionary/normalizer/pull/98), [#191](https://github.com/objectionary/normalizer/pull/191)) + - `normalizer metrics` to compute metrics of a given φ-expression (see [#153](https://github.com/objectionary/eo-phi-normalizer/pull/153)) + - `normalizer dataize` to run partial evaluation of φ-expressions with atoms (see [#187](https://github.com/objectionary/eo-phi-normalizer/pull/187)) + - `normalizer report` to generate report based on the results of testing against the EO compiler (see [#213](https://github.com/objectionary/eo-phi-normalizer/pull/213)) + - Add `--single` flag (see [#131](https://github.com/objectionary/eo-phi-normalizer/pull/131)) + - Add `--json` flag for machine-readable output format (see [#143](https://github.com/objectionary/eo-phi-normalizer/pull/143)) + - Add `--max-depth=N` and `--max-term-size=N` options to control limits for the normalizer (see [#173](https://github.com/objectionary/eo-phi-normalizer/pull/173)) + - Improve `--chain` option to provide better elaboration on the applied normalization rules and the dataization process (see [#195](https://github.com/objectionary/eo-phi-normalizer/pull/195)) +- Update rule set for φ-calculus (see [#152](https://github.com/objectionary/eo-phi-normalizer/pull/152) and some changes in [#136](https://github.com/objectionary/eo-phi-normalizer/pull/136) and [#166](https://github.com/objectionary/eo-phi-normalizer/pull/166)) +- Add property-based and regression tests for confluence (see [#136](https://github.com/objectionary/eo-phi-normalizer/pull/136) and [#166](https://github.com/objectionary/eo-phi-normalizer/pull/166)) +- Tests and metrics against the EO compiler and standard EO test suite (see [#98](https://github.com/objectionary/eo-phi-normalizer/pull/98), [#191](https://github.com/objectionary/eo-phi-normalizer/pull/191)) Fixes: -- Count metrics, including dataless objects, correctly (see [#142](https://github.com/objectionary/normalizer/pull/142), [#193](https://github.com/objectionary/normalizer/pull/193), [#211](https://github.com/objectionary/normalizer/pull/211)) -- Fix metavariables in context patterns (see [#174](https://github.com/objectionary/normalizer/pull/174)) -- Support empty Δ-bindings (see [#184](https://github.com/objectionary/normalizer/pull/184)) +- Count metrics, including dataless objects, correctly (see [#142](https://github.com/objectionary/eo-phi-normalizer/pull/142), [#193](https://github.com/objectionary/eo-phi-normalizer/pull/193), [#211](https://github.com/objectionary/eo-phi-normalizer/pull/211)) +- Fix metavariables in context patterns (see [#174](https://github.com/objectionary/eo-phi-normalizer/pull/174)) +- Support empty Δ-bindings (see [#184](https://github.com/objectionary/eo-phi-normalizer/pull/184)) -Documentation has been improved (see [#134](https://github.com/objectionary/normalizer/pull/134), [#221](https://github.com/objectionary/normalizer/pull/221)). +Documentation has been improved (see [#134](https://github.com/objectionary/eo-phi-normalizer/pull/134), [#221](https://github.com/objectionary/eo-phi-normalizer/pull/221)). Maintenance: -- Run CI on all pull requests (see [#156](https://github.com/objectionary/normalizer/pull/156)) -- Downgrade Stackage snapshot (see [#146](https://github.com/objectionary/normalizer/pull/146)) -- Add HLint to CI (see [#157](https://github.com/objectionary/normalizer/pull/157)) +- Run CI on all pull requests (see [#156](https://github.com/objectionary/eo-phi-normalizer/pull/156)) +- Downgrade Stackage snapshot (see [#146](https://github.com/objectionary/eo-phi-normalizer/pull/146)) +- Add HLint to CI (see [#157](https://github.com/objectionary/eo-phi-normalizer/pull/157)) ## v0.2.0 — 2024-02-16 -- Complete implementation of Yegor's rules (see [#109](https://github.com/objectionary/normalizer/pull/109), [#112](https://github.com/objectionary/normalizer/pull/112)) - - Support global counter in user-defined rules (see [#105](https://github.com/objectionary/normalizer/pull/105)) - - Context matching (global object and this object, see [#99](https://github.com/objectionary/normalizer/pull/99)) -- Fix grammar for $\varphi$-calculus (see [#97](https://github.com/objectionary/normalizer/pull/97) and [#127](https://github.com/objectionary/normalizer/pull/127)) +- Complete implementation of Yegor's rules (see [#109](https://github.com/objectionary/eo-phi-normalizer/pull/109), [#112](https://github.com/objectionary/eo-phi-normalizer/pull/112)) + - Support global counter in user-defined rules (see [#105](https://github.com/objectionary/eo-phi-normalizer/pull/105)) + - Context matching (global object and this object, see [#99](https://github.com/objectionary/eo-phi-normalizer/pull/99)) +- Fix grammar for $\varphi$-calculus (see [#97](https://github.com/objectionary/eo-phi-normalizer/pull/97) and [#127](https://github.com/objectionary/eo-phi-normalizer/pull/127)) - Improve documentation: - - Set up wesbite for documentation (see [#104](https://github.com/objectionary/normalizer/pull/104), [#124](https://github.com/objectionary/normalizer/pull/124), and [#128](https://github.com/objectionary/normalizer/pull/128)) - - Update CLI documentation (see [#113](https://github.com/objectionary/normalizer/pull/113)) + - Set up wesbite for documentation (see [#104](https://github.com/objectionary/eo-phi-normalizer/pull/104), [#124](https://github.com/objectionary/eo-phi-normalizer/pull/124), and [#128](https://github.com/objectionary/eo-phi-normalizer/pull/128)) + - Update CLI documentation (see [#113](https://github.com/objectionary/eo-phi-normalizer/pull/113)) - Improve command line interface: - - Support `--output`/`-o` command line option (see [#92](https://github.com/objectionary/normalizer/pull/92)) - - Remove logs from default output (see [#106](https://github.com/objectionary/normalizer/pull/106)) -- Allow collection of metrics for $\varphi$-terms (see [#121](https://github.com/objectionary/normalizer/pull/121)) + - Support `--output`/`-o` command line option (see [#92](https://github.com/objectionary/eo-phi-normalizer/pull/92)) + - Remove logs from default output (see [#106](https://github.com/objectionary/eo-phi-normalizer/pull/106)) +- Allow collection of metrics for $\varphi$-terms (see [#121](https://github.com/objectionary/eo-phi-normalizer/pull/121)) ## v0.1.0 - 2024-02-02 diff --git a/eo-phi-normalizer/README.md b/eo-phi-normalizer/README.md index 1ffb182e8..0b190daa1 100644 --- a/eo-phi-normalizer/README.md +++ b/eo-phi-normalizer/README.md @@ -1,8 +1,8 @@ # eo-phi-normalizer [![`rzk` on Hackage](https://img.shields.io/hackage/v/eo-phi-normalizer)](http://hackage.haskell.org/package/eo-phi-normalizer) -[![Haddock]()](https://www.objectionary.com/normalizer/haddock/) +[![Haddock]()](https://www.objectionary.com/eo-phi-normalizer/haddock/) Command line normalizer of 𝜑-calculus expressions (as produced by the [EO compiler](https://github.com/objectionary/eo)). -See . +See . diff --git a/eo-phi-normalizer/Setup.hs b/eo-phi-normalizer/Setup.hs index 14f294432..4abbabd76 100644 --- a/eo-phi-normalizer/Setup.hs +++ b/eo-phi-normalizer/Setup.hs @@ -30,7 +30,7 @@ main = #else False #endif - -- See the details on the command form in https://github.com/objectionary/normalizer/issues/347#issuecomment-2117097070 + -- See the details on the command form in https://github.com/objectionary/eo-phi-normalizer/issues/347#issuecomment-2117097070 command = intercalate "; " $ [ "set -ex" ] <> [ "chcp.com" | isWindows ] <> diff --git a/eo-phi-normalizer/app/Main.hs b/eo-phi-normalizer/app/Main.hs index 9253959f6..c6bd9adcf 100644 --- a/eo-phi-normalizer/app/Main.hs +++ b/eo-phi-normalizer/app/Main.hs @@ -343,7 +343,7 @@ commandParserInfo = CommandParserInfo'Pipeline { report = info (CLI'Pipeline'Report' <$> commandParser.pipeline'.report) (progDesc "Generate reports about initial and normalized PHI programs.") , prepareTests = info (CLI'Pipeline'PrepareTests' <$> commandParser.pipeline'.prepareTests) (progDesc "Prepare EO test files for the pipeline.") - , printDataizeConfigs = info (CLI'Pipeline'PrintDataizeConfigs' <$> commandParser.pipeline'.printDataizeConfigs) (progDesc [fmt|Print configs for the `normalizer {commandNames.dataize}` command.|]) + , printDataizeConfigs = info (CLI'Pipeline'PrintDataizeConfigs' <$> commandParser.pipeline'.printDataizeConfigs) (progDesc [fmt|Print configs for the `{commandNames.dataize}` command.|]) } , test = info (CLI'Test' <$> commandParser.test) (progDesc "Run unit tests in given files with user-defined rules.") } diff --git a/eo-phi-normalizer/eo-phi-normalizer.cabal b/eo-phi-normalizer/eo-phi-normalizer.cabal index 3f0336170..b45365f95 100644 --- a/eo-phi-normalizer/eo-phi-normalizer.cabal +++ b/eo-phi-normalizer/eo-phi-normalizer.cabal @@ -208,7 +208,7 @@ library , yaml default-language: Haskell2010 -executable normalizer +executable eo-phi-normalizer main-is: Main.hs other-modules: Paths_eo_phi_normalizer diff --git a/eo-phi-normalizer/package.yaml b/eo-phi-normalizer/package.yaml index dcc2e2e62..174e9c06e 100644 --- a/eo-phi-normalizer/package.yaml +++ b/eo-phi-normalizer/package.yaml @@ -91,7 +91,7 @@ library: - Language.EO.Phi.Rules.Syntax.Skel executables: - normalizer: + eo-phi-normalizer: main: Main.hs source-dirs: app ghc-options: diff --git a/flake.nix b/flake.nix index a7b80ef54..66b469e96 100644 --- a/flake.nix +++ b/flake.nix @@ -203,14 +203,14 @@ ${lib.concatMapStringsSep "\n" (x: "mdsh -i site/docs/src/${x} --work_dir .") [ "common/celsius.md" - "normalizer.md" + "eo-phi-normalizer.md" "pipeline.md" "quick-start.md" - "normalizer/dataize.md" - "normalizer/metrics.md" - "normalizer/transform.md" - "normalizer/print-rules.md" - "normalizer/test.md" + "eo-phi-normalizer/dataize.md" + "eo-phi-normalizer/metrics.md" + "eo-phi-normalizer/transform.md" + "eo-phi-normalizer/print-rules.md" + "eo-phi-normalizer/test.md" "contributing.md" ]} @@ -278,7 +278,7 @@ prefix = "nix run .#"; packages = { inherit (self'.packages) pipeline update-markdown site-dev site-build; - normalizer = self'.packages.default; + eo-phi-normalizer = self'.packages.default; }; } ]; diff --git a/hie.yaml b/hie.yaml index 997e0b61d..528938b0a 100644 --- a/hie.yaml +++ b/hie.yaml @@ -4,13 +4,7 @@ cradle: component: "eo-phi-normalizer:lib" - path: "eo-phi-normalizer/app/Main.hs" - component: "eo-phi-normalizer:exe:normalizer" - - - path: "eo-phi-normalizer/app/Paths_eo_phi_normalizer.hs" - component: "eo-phi-normalizer:exe:normalize-phi" - - - path: "eo-phi-normalizer/app/Paths_eo_phi_normalizer.hs" - component: "eo-phi-normalizer:exe:normalize-phi" + component: "eo-phi-normalizer:exe:eo-phi-normalizer" - path: "eo-phi-normalizer/test" component: "eo-phi-normalizer:test:spec" diff --git a/package-lock.json b/package-lock.json index 47ff42c99..746fb8cc0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,9 +1,10 @@ { - "name": "normalizer", + "name": "eo-phi-normalizer", "lockfileVersion": 3, "requires": true, "packages": { "": { + "name": "eo-phi-normalizer", "devDependencies": { "eolang": "^0.21.0", "prettier": "^3.2.5" diff --git a/package.json b/package.json index 36ec0ced1..dd1fdcd81 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,5 @@ { + "name": "eo-phi-normalizer", "devDependencies": { "eolang": "^0.21.0", "prettier": "^3.2.5" diff --git a/proposals/000-template.md b/proposals/000-template.md index f006a5337..f8526ea8f 100644 --- a/proposals/000-template.md +++ b/proposals/000-template.md @@ -4,7 +4,7 @@ | author(s) | date-accepted | pr-url | implemented | | ------------------ | ------------------------------------- | ----------------------------------------------- | -------------------------------------------------------- | -| [Full author names] | [Date when the proposal was accepted] | [URL of a PR where this proposal was discussed] | [normalizer version where this proposal was implemented] | +| [Full author names] | [Date when the proposal was accepted] | [URL of a PR where this proposal was discussed] | [eo-phi-normalizer version where this proposal was implemented] | ## Motivation @@ -25,7 +25,7 @@ Strive for a complete definition. Your specification may include, - LBNF grammar and semantics of any new syntactic constructs (see [LBNF reference](https://bnfc.readthedocs.io/en/latest/lbnf.html)). -- how the proposed change interacts with existing normalizer features, in case that is otherwise ambiguous +- how the proposed change interacts with existing eo-phi-normalizer features, in case that is otherwise ambiguous Strive for _precision_. diff --git a/proposals/README.md b/proposals/README.md index 8e40a215e..47ce0e2e3 100644 --- a/proposals/README.md +++ b/proposals/README.md @@ -1,6 +1,6 @@ # Proposals -A proposal is a document describing a proposed change to the normalizer. +A proposal is a document describing a proposed change to the Normalizer. ## Proposal format @@ -14,15 +14,15 @@ A proposal is a document describing a proposed change to the normalizer. ## Proposal process -1. [No label] An author submits a proposal for discussion as a pull request against the `normalizer` repository ([link](https://github.com/objectionary/normalizer)). -1. [[proposal under review](https://github.com/objectionary/normalizer/labels/proposal%20under%20review)] The `normalizer` team discusses the proposal in the commit section of the pull request, while the author refines the proposal. This phase lasts as long as necessary. -1. Eventually, the normalizer team does one of these actions: - 1. Rejects the proposal [[proposal rejected](https://github.com/objectionary/normalizer/labels/proposal%20rejected)]. - 1. Passes the proposal back to the author(s) for review [[proposal needs revision](https://github.com/objectionary/normalizer/labels/Proposal%20needs%20revision)]. +1. [No label] An author submits a proposal for discussion as a pull request against the ([repository](https://github.com/objectionary/eo-phi-normalizer)). +1. [[proposal under review](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20under%20review)] The Normalizer team discusses the proposal in the commit section of the pull request, while the author refines the proposal. This phase lasts as long as necessary. +1. Eventually, the Normalizer team does one of these actions: + 1. Rejects the proposal [[proposal rejected](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20rejected)]. + 1. Passes the proposal back to the author(s) for review [[proposal needs revision](https://github.com/objectionary/eo-phi-normalizer/labels/Proposal%20needs%20revision)]. 1. Accepts the proposal. - - [[proposal accepted](https://github.com/objectionary/normalizer/labels/proposal%20accepted)] + - [[proposal accepted](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20accepted)] - Proposal priority - one of these labels: - - [[proposal priority: high](https://github.com/objectionary/normalizer/labels/proposal%20priority%3A%20high)] - - [[proposal priority: medium](https://github.com/objectionary/normalizer/labels/proposal%20priority%3A%20medium)] - - [[proposal priority: low](https://github.com/objectionary/normalizer/labels/proposal%20priority%3A%20low)] -1. [[proposal implemented](https://github.com/objectionary/normalizer/labels/proposal%20implemented)] Once a proposal is accepted, it still has to be implemented. The author(s) may do that, or someone else. We mark the proposal implemented once it hits normalizer master branch (and we are happy to be nudged to do so by email, GitHub issue, or a comment on the relevant pull request), and the corresponding documentation on the site is updated. + - [[proposal priority: high](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20priority%3A%20high)] + - [[proposal priority: medium](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20priority%3A%20medium)] + - [[proposal priority: low](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20priority%3A%20low)] +1. [[proposal implemented](https://github.com/objectionary/eo-phi-normalizer/labels/proposal%20implemented)] Once a proposal is accepted, it still has to be implemented. The author(s) may do that, or someone else. We mark the proposal implemented once it hits the `master` branch (and we are happy to be nudged to do so by email, GitHub issue, or a comment on the relevant pull request), and the corresponding documentation on the site is updated. diff --git a/scripts/lib.sh b/scripts/lib.sh index 4380f06ff..598df4575 100755 --- a/scripts/lib.sh +++ b/scripts/lib.sh @@ -11,8 +11,8 @@ PIPELINE_EO_FILTERED_DIR="$PIPELINE_DIR/eo-filtered" PIPELINE_EO_INITIAL_DIR="$PIPELINE_DIR/eo-initial" PIPELINE_EO_NORMALIZED_DIR="$PIPELINE_DIR/eo-normalized" PIPELINE_PHI_NORMALIZED_DIR="$PIPELINE_DIR/phi-normalized" -PIPELINE_NORMALIZER_DIR="$PWD/eo-phi-normalizer" -PIPELINE_NORMALIZER_DATA_DIR="$PIPELINE_NORMALIZER_DIR/data" +PIPELINE_EO_PHI_NORMALIZER_DIR="$PWD/eo-phi-normalizer" +PIPELINE_EO_PHI_NORMALIZER_DATA_DIR="$PIPELINE_EO_PHI_NORMALIZER_DIR/data" PIPELINE_REPORT_DIR="$PWD/report" PIPELINE_EO_YAML_DIR="$PIPELINE_DIR/eo-yaml" @@ -30,13 +30,13 @@ PIPELINE_LOCK_FILE_NEW="$PIPELINE_DIR/$PIPELINE_LOCK_FILE_NEW_NAME" PIPELINE_LOCK_FILE_RELATIVE="$PIPELINE_DIR_RELATIVE/$PIPELINE_LOCK_FILE_NAME" PIPELINE_LOCK_FILE_NEW_RELATIVE="$PIPELINE_DIR_RELATIVE/$PIPELINE_LOCK_FILE_NEW_NAME" -NORMALIZER_INSTALLED="${NORMALIZER_INSTALLED:-false}" +EO_PHI_NORMALIZER_INSTALLED="${EO_PHI_NORMALIZER_INSTALLED:-false}" PIPELINE_LOGS_DIR="$PIPELINE_DIR/logs" PIPELINE_TEST_EO_INITIAL_LOGS="$PIPELINE_LOGS_DIR/test-initial-logs.txt" PIPELINE_TEST_EO_NORMALIZED_LOGS="$PIPELINE_LOGS_DIR/test-normalized-logs.txt" -SYNTAX_DIR="$PIPELINE_NORMALIZER_DIR/src/Language/EO/Phi/Syntax" +SYNTAX_DIR="$PIPELINE_EO_PHI_NORMALIZER_DIR/src/Language/EO/Phi/Syntax" function init_logs { mkdir -p "$PIPELINE_LOGS_DIR" @@ -165,24 +165,24 @@ function eo { export -f eo -function install_normalizer { +function install_eo_phi_normalizer { set_installation_path add_installation_path_to_path print_message "Install the Normalizer" - if [[ "$NORMALIZER_INSTALLED" = "true" ]]; then + if [[ "$EO_PHI_NORMALIZER_INSTALLED" = "true" ]]; then if [[ "$IS_WINDOWS" = "true" ]]; then - mv "$INSTALLATION_PATH/normalizer.exe" "$INSTALLATION_PATH/normalizer" + mv "$INSTALLATION_PATH/eo-phi-normalizer.exe" "$INSTALLATION_PATH/eo-phi-normalizer" fi else - stack install eo-phi-normalizer:exe:normalizer --ghc-options -O2 + stack install eo-phi-normalizer:exe:eo-phi-normalizer --ghc-options -O2 fi print_message "The Normalizer is installed" } -export -f install_normalizer +export -f install_eo_phi_normalizer function run_pipeline { bash "$PIPELINE_SCRIPT" @@ -240,9 +240,9 @@ export -f check_syntax_files_exist function write_dependencies_markdown_for_eo_version { local eo_version=$1 - export PIPELINE_NORMALIZER_DATA_DIR + export PIPELINE_EO_PHI_NORMALIZER_DATA_DIR - local version_data_dir="$PIPELINE_NORMALIZER_DATA_DIR/$eo_version" + local version_data_dir="$PIPELINE_EO_PHI_NORMALIZER_DATA_DIR/$eo_version" export version_data_dir function print_program { @@ -274,10 +274,10 @@ function write_dependencies_markdown_for_eo_version { export -f write_dependencies_markdown_for_eo_version function write_dependencies_markdown { - export PIPELINE_NORMALIZER_DATA_DIR + export PIPELINE_EO_PHI_NORMALIZER_DATA_DIR # shellcheck disable=SC2038 - find "$PIPELINE_NORMALIZER_DATA_DIR" -mindepth 1 -maxdepth 1 -type d \ + find "$PIPELINE_EO_PHI_NORMALIZER_DATA_DIR" -mindepth 1 -maxdepth 1 -type d \ | xargs -I {} basename {} \ | xargs -I {} bash -c "write_dependencies_markdown_for_eo_version {}" } diff --git a/scripts/pipeline.sh b/scripts/pipeline.sh index 970644250..3e0cb1dff 100755 --- a/scripts/pipeline.sh +++ b/scripts/pipeline.sh @@ -19,7 +19,7 @@ function generate_eo_tests { mkdir_clean "$PIPELINE_EO_YAML_DIR" mkdir_clean "$PIPELINE_EO_FILTERED_DIR" - normalizer pipeline prepare-tests --config "$PIPELINE_CONFIG_FILE" + eo-phi-normalizer pipeline prepare-tests --config "$PIPELINE_CONFIG_FILE" } function convert_eo_to_phi { @@ -35,7 +35,7 @@ function convert_eo_to_phi { cd "$PIPELINE_DIR" } -function update_normalizer_data_files { +function update_eo_phi_normalizer_data_files { print_message "Update data files in eo-phi-normalizer" @@ -43,7 +43,7 @@ function update_normalizer_data_files { print_message "Update *.phi files" - local data_directory="$PIPELINE_NORMALIZER_DATA_DIR/$EO" + local data_directory="$PIPELINE_EO_PHI_NORMALIZER_DATA_DIR/$EO" mkdir_clean "$data_directory" cp -r .eoc/phi/org "$data_directory" @@ -107,14 +107,14 @@ function normalize { cd "$PIPELINE_PHI_INITIAL_DIR" local dataize_configs - eval "dataize_configs=($(normalizer pipeline print-dataize-configs --single-line --strip-phi-prefix "$PIPELINE_PHI_INITIAL_DIR_RELATIVE/" --config "$PIPELINE_CONFIG_FILE"))" + eval "dataize_configs=($(eo-phi-normalizer pipeline print-dataize-configs --single-line --strip-phi-prefix "$PIPELINE_PHI_INITIAL_DIR_RELATIVE/" --config "$PIPELINE_CONFIG_FILE"))" local dependency_files dependency_files="$(find "$PIPELINE_EO_FILTERED_DIR"/.eoc/phi/org/eolang -type f)" export dependency_files export PIPELINE_PHI_NORMALIZED_DIR - export PIPELINE_NORMALIZER_DIR + export PIPELINE_EO_PHI_NORMALIZER_DIR function extract { yq -pj -oj -r "$1" <<< "$2" @@ -152,7 +152,7 @@ function normalize { set -x # shellcheck disable=SC2086 - normalizer dataize \ + eo-phi-normalizer dataize \ --minimize-stuck-terms \ --as-package \ --recursive \ @@ -175,7 +175,7 @@ function generate_report { cd "$PWD_DIR" - normalizer pipeline report --config "$PIPELINE_CONFIG_FILE" + eo-phi-normalizer pipeline report --config "$PIPELINE_CONFIG_FILE" } function convert_normalized_phi_to_eo { @@ -203,12 +203,12 @@ function test_with_normalization { } update_pipeline_lock -install_normalizer +install_eo_phi_normalizer if [[ "$PIPELINE_LOCK_CHANGED" = true ]]; then generate_eo_tests convert_eo_to_phi - update_normalizer_data_files + update_eo_phi_normalizer_data_files convert_phi_to_eo test_without_normalization fi diff --git a/scripts/update-markdown.sh b/scripts/update-markdown.sh index 6bf16a84a..5d79ac1a9 100755 --- a/scripts/update-markdown.sh +++ b/scripts/update-markdown.sh @@ -3,14 +3,14 @@ mdsh mdsh -i site/docs/src/common/celsius.md --work_dir . -mdsh -i site/docs/src/normalizer.md --work_dir . +mdsh -i site/docs/src/eo-phi-normalizer.md --work_dir . mdsh -i site/docs/src/pipeline.md --work_dir . mdsh -i site/docs/src/quick-start.md --work_dir . -mdsh -i site/docs/src/normalizer/dataize.md --work_dir . -mdsh -i site/docs/src/normalizer/metrics.md --work_dir . -mdsh -i site/docs/src/normalizer/transform.md --work_dir . -mdsh -i site/docs/src/normalizer/print-rules.md --work_dir . -mdsh -i site/docs/src/normalizer/test.md --work_dir . +mdsh -i site/docs/src/eo-phi-normalizer/dataize.md --work_dir . +mdsh -i site/docs/src/eo-phi-normalizer/metrics.md --work_dir . +mdsh -i site/docs/src/eo-phi-normalizer/transform.md --work_dir . +mdsh -i site/docs/src/eo-phi-normalizer/print-rules.md --work_dir . +mdsh -i site/docs/src/eo-phi-normalizer/test.md --work_dir . mdsh -i site/docs/src/contributing.md --work_dir . rm celsius.phi diff --git a/site/docs/book.toml b/site/docs/book.toml index 1281d7cb7..d8565e2d8 100644 --- a/site/docs/book.toml +++ b/site/docs/book.toml @@ -9,7 +9,7 @@ title = "phi-normalizer" additional-css = ["theme/pagetoc.css"] additional-js = ["theme/pagetoc.js"] mathjax-support = true -git-repository-url = "https://github.com/objectionary/normalizer" +git-repository-url = "https://github.com/objectionary/eo-phi-normalizer" git-repository-icon = "fa-github" [build] diff --git a/site/docs/src/SUMMARY.md b/site/docs/src/SUMMARY.md index 9c10b26ac..6d8b0edba 100644 --- a/site/docs/src/SUMMARY.md +++ b/site/docs/src/SUMMARY.md @@ -6,14 +6,14 @@ - [Pipeline](./pipeline.md) - [Metrics](./metrics.md) - [Atoms](./atoms.md) -- [Normalizer](./normalizer.md) - - [normalizer transform](./normalizer/transform.md) - - [normalizer dataize](./normalizer/dataize.md) - - [normalizer metrics](./normalizer/metrics.md) - - [normalizer pipeline](./normalizer/pipeline.md) - - [normalizer pipeline prepare-tests](./normalizer/pipeline/prepare-tests.md) - - [normalizer pipeline print-dataize-configs](./normalizer/pipeline/print-dataize-configs.md) - - [normalizer pipeline report](./normalizer/pipeline/report.md) - - [normalizer test](./normalizer/test.md) - - [normalizer print-rules](./normalizer/print-rules.md) +- [eo-phi-normalizer](./eo-phi-normalizer.md) + - [eo-phi-normalizer transform](./eo-phi-normalizer/transform.md) + - [eo-phi-normalizer dataize](./eo-phi-normalizer/dataize.md) + - [eo-phi-normalizer metrics](./eo-phi-normalizer/metrics.md) + - [eo-phi-normalizer pipeline](./eo-phi-normalizer/pipeline.md) + - [eo-phi-normalizer pipeline prepare-tests](./eo-phi-normalizer/pipeline/prepare-tests.md) + - [eo-phi-normalizer pipeline print-dataize-configs](./eo-phi-normalizer/pipeline/print-dataize-configs.md) + - [eo-phi-normalizer pipeline report](./eo-phi-normalizer/pipeline/report.md) + - [eo-phi-normalizer test](./eo-phi-normalizer/test.md) + - [eo-phi-normalizer print-rules](./eo-phi-normalizer/print-rules.md) - [Contributing](./contributing.md) diff --git a/site/docs/src/atoms.md b/site/docs/src/atoms.md index b848dd969..5f3b4a379 100644 --- a/site/docs/src/atoms.md +++ b/site/docs/src/atoms.md @@ -1,6 +1,6 @@ # Atoms -The `normalizer` uses atoms implemented in Haskell. +The `eo-phi-normalizer` uses atoms implemented in Haskell. The sections below explain how to update them. ## Enter the repository diff --git a/site/docs/src/commands.md b/site/docs/src/commands.md index 3d4a5c032..9416e1bcd 100644 --- a/site/docs/src/commands.md +++ b/site/docs/src/commands.md @@ -1,3 +1,3 @@ # Commands -This section lists commands and options that you can use when you work with `normalizer`. +This section lists commands and options that you can use when you work with `eo-phi-normalizer`. diff --git a/site/docs/src/common/enter-repository.md b/site/docs/src/common/enter-repository.md index c3e6a887c..2ce8feb28 100644 --- a/site/docs/src/common/enter-repository.md +++ b/site/docs/src/common/enter-repository.md @@ -1,6 +1,6 @@ Clone and enter the project repository. ```sh -git clone https://github.com/objectionary/normalizer --recurse-submodules -cd normalizer +git clone https://github.com/objectionary/eo-phi-normalizer --recurse-submodules +cd eo-phi-normalizer ``` diff --git a/site/docs/src/common/install.md b/site/docs/src/common/install.md index 6088ee690..d1a4e6880 100644 --- a/site/docs/src/common/install.md +++ b/site/docs/src/common/install.md @@ -1,4 +1,4 @@ -Install `normalizer`. +Install `eo-phi-normalizer`. ```sh export LC_ALL=C.UTF-8 diff --git a/site/docs/src/contributing.md b/site/docs/src/contributing.md index 0b6dec7a0..1adc02132 100644 --- a/site/docs/src/contributing.md +++ b/site/docs/src/contributing.md @@ -2,7 +2,7 @@ ## Issues -Check open issues ([link](https://github.com/objectionary/normalizer/issues)). +Check open issues ([link](https://github.com/objectionary/eo-phi-normalizer/issues)). ### Issue labels @@ -40,14 +40,14 @@ stack test ## Run -Run the `normalizer` executable via `stack run`. +Run the `eo-phi-normalizer` executable via `stack run`. ```$ as console -stack run normalizer -- --help +stack run eo-phi-normalizer -- --help ``` ```console -Usage: normalizer COMMAND +Usage: eo-phi-normalizer COMMAND Work with PHI expressions. @@ -72,7 +72,7 @@ stack run -- --help ``` ```console -Usage: normalizer COMMAND +Usage: eo-phi-normalizer COMMAND Work with PHI expressions. @@ -110,7 +110,7 @@ Run `npm i` to locally install the `prettier` version that we use. ### Automatic updates -In CI, on the `master` branch, we run a [script](https://github.com/objectionary/normalizer/blob/master/scripts/update-markdown.sh) to update Markdown files and then we commit changes. +In CI, on the `master` branch, we run a [script](https://github.com/objectionary/eo-phi-normalizer/blob/master/scripts/update-markdown.sh) to update Markdown files and then we commit changes. So, no worries if you haven't run `mdsh` in your PR! @@ -163,7 +163,7 @@ chmod +x scripts/run-fourmolu.sh See [docs](https://pre-commit.com/#adding-pre-commit-plugins-to-your-project). -See [.pre-commit-config.yaml](https://github.com/objectionary/normalizer/blob/master/.pre-commit-config.yaml). +See [.pre-commit-config.yaml](https://github.com/objectionary/eo-phi-normalizer/blob/master/.pre-commit-config.yaml). You can run a specific hook (see [docs](https://pre-commit.com/#pre-commit-run)): diff --git a/site/docs/src/normalizer.md b/site/docs/src/eo-phi-normalizer.md similarity index 80% rename from site/docs/src/normalizer.md rename to site/docs/src/eo-phi-normalizer.md index 1f9fd83fb..184fa394d 100644 --- a/site/docs/src/normalizer.md +++ b/site/docs/src/eo-phi-normalizer.md @@ -1,13 +1,13 @@ -# Normalizer +# `eo-phi-normalizer` -See commands supported by the `normalizer` executable. +See commands supported by the `eo-phi-normalizer` executable. ```$ as console -normalizer --help +eo-phi-normalizer --help ``` ```console -Usage: normalizer COMMAND +Usage: eo-phi-normalizer COMMAND Work with PHI expressions. diff --git a/site/docs/src/normalizer/dataize.md b/site/docs/src/eo-phi-normalizer/dataize.md similarity index 94% rename from site/docs/src/normalizer/dataize.md rename to site/docs/src/eo-phi-normalizer/dataize.md index 30e6dc9d1..5601c6291 100644 --- a/site/docs/src/normalizer/dataize.md +++ b/site/docs/src/eo-phi-normalizer/dataize.md @@ -1,10 +1,10 @@ -# `normalizer dataize` +# `eo-phi-normalizer dataize` Dataization is the process through which data is extracted from a given program/object. ## Dataization process -To dataize a given program written in \\( \varphi \\)-calculus, the first step is to normalize it according to the process outlined in [normalizer transform](./transform.md) docs. +To dataize a given program written in \\( \varphi \\)-calculus, the first step is to normalize it according to the process outlined in [eo-phi-normalizer transform](./transform.md) docs. Then, a single step of dataization is performed according to the following rules in order of priority: 1. If the object is a formation that contains a \\( \Delta \\)-binding and no empty bindings, the bytes attached to it are returned @@ -28,15 +28,17 @@ Note that dataization assumes that the given set of normalization rules are alre ### `--help` ```$ as console -normalizer dataize --help +eo-phi-normalizer dataize --help ``` ```console -Usage: normalizer dataize [-r|--rules FILE] [FILE] [-d|--dependency-file FILE] - [-o|--output-file FILE] [--recursive] [--chain] - [--wrap-raw-bytes] [--tex] [--as-package] - [--minimize-stuck-terms] [--disable-atom ATOM_NAME] - [--enable-atom ATOM_NAME] +Usage: eo-phi-normalizer dataize [-r|--rules FILE] [FILE] + [-d|--dependency-file FILE] + [-o|--output-file FILE] [--recursive] [--chain] + [--wrap-raw-bytes] [--tex] [--as-package] + [--minimize-stuck-terms] + [--disable-atom ATOM_NAME] + [--enable-atom ATOM_NAME] Dataize a PHI program. @@ -74,7 +76,7 @@ Similar to `--rules` for the `transform` subcommand, this argument accepts the p If the `--chain` argument is passed, all the intermediate steps of normalization + dataization are printed to the console (or the output file if chosen). ```$ as console -normalizer dataize --chain --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer dataize --chain --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -599,7 +601,7 @@ Can be used multiple times to inject multiple dependencies. Applies the normalization+dataization process recursively until it reaches bytes or no longer modifies the object (stalls). ```$ as console -normalizer dataize --recursive --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer dataize --recursive --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -667,7 +669,7 @@ Can be combined with `--chain` to print all the intermediate steps of both norma Enable an atom by name. ```$ as console -normalizer dataize --minimize-stuck-terms --recursive --enable-atom "Lorg_eolang_dataized" --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer dataize --minimize-stuck-terms --recursive --enable-atom "Lorg_eolang_dataized" --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -689,7 +691,7 @@ normalizer dataize --minimize-stuck-terms --recursive --enable-atom "Lorg_eolang Disable an atom by name. ```$ as console -normalizer dataize --minimize-stuck-terms --recursive --disable-atom "Lorg_eolang_dataized" --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer dataize --minimize-stuck-terms --recursive --disable-atom "Lorg_eolang_dataized" --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -711,7 +713,7 @@ normalizer dataize --minimize-stuck-terms --recursive --disable-atom "Lorg_eolan If no argument is given for the input file, `stdin` is consumed until `EOF`. ```$ as console -cat celsius.phi | normalizer dataize --recursive --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml +cat celsius.phi | eo-phi-normalizer dataize --recursive --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml ``` ```console diff --git a/site/docs/src/normalizer/metrics.md b/site/docs/src/eo-phi-normalizer/metrics.md similarity index 86% rename from site/docs/src/normalizer/metrics.md rename to site/docs/src/eo-phi-normalizer/metrics.md index 80296e5b4..293a0152e 100644 --- a/site/docs/src/normalizer/metrics.md +++ b/site/docs/src/eo-phi-normalizer/metrics.md @@ -1,4 +1,4 @@ -# `normalizer metrics` +# `eo-phi-normalizer metrics` ## Metrics @@ -13,11 +13,11 @@ See [Metrics](../metrics.md) for the specification of metrics collected by this ### `--help` ```$ as console -normalizer metrics --help +eo-phi-normalizer metrics --help ``` ```console -Usage: normalizer metrics [FILE] [-o|--output-file FILE] +Usage: eo-phi-normalizer metrics [FILE] [-o|--output-file FILE] [-b|--bindings-path PATH] Collect metrics for a PHI program. @@ -37,7 +37,7 @@ Available options: ### `FILE` ```$ as json -normalizer metrics celsius.phi +eo-phi-normalizer metrics celsius.phi ``` ```json @@ -55,7 +55,7 @@ normalizer metrics celsius.phi ### `FILE` not specified (read from stdin) ```$ as json -cat celsius.phi | normalizer metrics +cat celsius.phi | eo-phi-normalizer metrics ``` ```json @@ -73,7 +73,7 @@ cat celsius.phi | normalizer metrics ### `--bindings-path` ```$ as console -normalizer metrics --bindings-path org.eolang celsius.phi +eo-phi-normalizer metrics --bindings-path org.eolang celsius.phi ``` ```console diff --git a/site/docs/src/normalizer/pipeline.md b/site/docs/src/eo-phi-normalizer/pipeline.md similarity index 67% rename from site/docs/src/normalizer/pipeline.md rename to site/docs/src/eo-phi-normalizer/pipeline.md index 31e101b00..b75a46161 100644 --- a/site/docs/src/normalizer/pipeline.md +++ b/site/docs/src/eo-phi-normalizer/pipeline.md @@ -1,3 +1,3 @@ -# `normalizer pipeline` +# `eo-phi-normalizer pipeline` This command is used in the [pipeline](../pipeline.md) script. diff --git a/site/docs/src/normalizer/pipeline/prepare-tests.md b/site/docs/src/eo-phi-normalizer/pipeline/prepare-tests.md similarity index 66% rename from site/docs/src/normalizer/pipeline/prepare-tests.md rename to site/docs/src/eo-phi-normalizer/pipeline/prepare-tests.md index a84ec0c78..f7b13b05b 100644 --- a/site/docs/src/normalizer/pipeline/prepare-tests.md +++ b/site/docs/src/eo-phi-normalizer/pipeline/prepare-tests.md @@ -1,4 +1,4 @@ -# `normalizer pipeline prepare-tests` +# `eo-phi-normalizer pipeline prepare-tests` ## `--config` @@ -6,5 +6,5 @@ This command reads the [pipeline configuration](../pipeline.md#pipeline-configur ```sh source scripts/lib.sh -normalizer pipeline prepare-tests --config "$PIPELINE_CONFIG_FILE" +eo-phi-normalizer pipeline prepare-tests --config "$PIPELINE_CONFIG_FILE" ``` diff --git a/site/docs/src/eo-phi-normalizer/pipeline/print-dataize-configs.md b/site/docs/src/eo-phi-normalizer/pipeline/print-dataize-configs.md new file mode 100644 index 000000000..631643825 --- /dev/null +++ b/site/docs/src/eo-phi-normalizer/pipeline/print-dataize-configs.md @@ -0,0 +1,10 @@ +# `eo-phi-normalizer pipeline print-dataize-configs` + +## `--config`, `--single-line`, `--strip-phi-prefix` + +This commands reads the [pipeline configuration](../../pipeline.md#pipeline-configuration) and prints configurations for the [eo-phi-normalizer dataize](../dataize.md). + +```sh +source scripts/lib.sh +eo-phi-normalizer pipeline print-dataize-configs --single-line --strip-phi-prefix "$PIPELINE_PHI_INITIAL_DIR_RELATIVE/" --config "$PIPELINE_CONFIG_FILE" +``` diff --git a/site/docs/src/normalizer/pipeline/report.md b/site/docs/src/eo-phi-normalizer/pipeline/report.md similarity index 74% rename from site/docs/src/normalizer/pipeline/report.md rename to site/docs/src/eo-phi-normalizer/pipeline/report.md index 6503bee9c..382f9773b 100644 --- a/site/docs/src/normalizer/pipeline/report.md +++ b/site/docs/src/eo-phi-normalizer/pipeline/report.md @@ -1,8 +1,8 @@ -# `normalizer pipeline report` +# `eo-phi-normalizer pipeline report` ## Reports -The `normalizer pipeline report` command generates reports about initial and normalized `PHI` programs. +The `eo-phi-normalizer pipeline report` command generates reports about initial and normalized `PHI` programs. The reports contain detailed information about metrics collected for these programs. @@ -31,11 +31,11 @@ The report configuration is stored in the `report` object in the [pipeline confi ### `--help` ```$ as console -normalizer pipeline report --help +eo-phi-normalizer pipeline report --help ``` ```console -Usage: normalizer pipeline report (-c|--config FILE) +Usage: eo-phi-normalizer pipeline report (-c|--config FILE) Generate reports about initial and normalized PHI programs. @@ -47,5 +47,5 @@ Available options: ### `--config` ```$ as console -normalizer pipeline report --config pipeline/config.yaml +eo-phi-normalizer pipeline report --config pipeline/config.yaml ``` diff --git a/site/docs/src/normalizer/print-rules.md b/site/docs/src/eo-phi-normalizer/print-rules.md similarity index 95% rename from site/docs/src/normalizer/print-rules.md rename to site/docs/src/eo-phi-normalizer/print-rules.md index a48ba19de..a387c1068 100644 --- a/site/docs/src/normalizer/print-rules.md +++ b/site/docs/src/eo-phi-normalizer/print-rules.md @@ -1,15 +1,15 @@ -# `normalizer print-rules` +# `eo-phi-normalizer print-rules` ## CLI ### `--help` ```$ as console -normalizer print-rules --help +eo-phi-normalizer print-rules --help ``` ```console -Usage: normalizer print-rules [-r|--rules FILE] [--tex] [-c|--compact] +Usage: eo-phi-normalizer print-rules [-r|--rules FILE] [--tex] [-c|--compact] Print rules in LaTeX format. @@ -28,7 +28,7 @@ The command below prints to the console rules from `yegor.yaml`, listing each co ![rules-latex](../media/print-rules-tex.png) ```$ as tex -normalizer print-rules --tex +eo-phi-normalizer print-rules --tex ``` ```tex @@ -60,7 +60,7 @@ The compact version prints rules listing all conditions on a single line. ![rules-latex-compact](../media/print-rules-tex-compact.png) ```$ as tex -normalizer print-rules --tex --compact +eo-phi-normalizer print-rules --tex --compact ``` ```tex diff --git a/site/docs/src/normalizer/test.md b/site/docs/src/eo-phi-normalizer/test.md similarity index 83% rename from site/docs/src/normalizer/test.md rename to site/docs/src/eo-phi-normalizer/test.md index c95b3cdae..34277e05f 100644 --- a/site/docs/src/normalizer/test.md +++ b/site/docs/src/eo-phi-normalizer/test.md @@ -1,15 +1,15 @@ -# `normalizer test` +# `eo-phi-normalizer test` ## CLI ### `--help` ```$ as console -normalizer test --help +eo-phi-normalizer test --help ``` ```console -Usage: normalizer test [-r|--rules FILE] +Usage: eo-phi-normalizer test [-r|--rules FILE] Run unit tests in given files with user-defined rules. @@ -21,7 +21,7 @@ Available options: ### Run tests in a file ```console -normalizer test --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml +eo-phi-normalizer test --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml ``` +`$ eo-phi-normalizer test --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml | sed -e 's/\(Finished in\) \([0-9]\.[0-9]\+\)/\1 0.0062/'` as console --> ```console User-defined rules unit tests diff --git a/site/docs/src/normalizer/transform.md b/site/docs/src/eo-phi-normalizer/transform.md similarity index 85% rename from site/docs/src/normalizer/transform.md rename to site/docs/src/eo-phi-normalizer/transform.md index 9eaa63b97..591232269 100644 --- a/site/docs/src/normalizer/transform.md +++ b/site/docs/src/eo-phi-normalizer/transform.md @@ -1,20 +1,20 @@ -# `normalizer transform` +# `eo-phi-normalizer transform` ## `MetaPHI` You can define [rewrite rules](https://en.wikipedia.org/wiki/Rewriting#Term_rewriting_systems) for the `PHI` language using `YAML` and the `MetaPHI` language that is a superset of `PHI`. -See the `MetaPHI` [Labelled BNF](https://bnfc.readthedocs.io/en/latest/lbnf.html) in [Syntax.cf](https://github.com/objectionary/normalizer/blob/master/eo-phi-normalizer/grammar/EO/Phi/Syntax.cf). +See the `MetaPHI` [Labelled BNF](https://bnfc.readthedocs.io/en/latest/lbnf.html) in [Syntax.cf](https://github.com/objectionary/eo-phi-normalizer/blob/master/eo-phi-normalizer/grammar/EO/Phi/Syntax.cf). ## phi-paper rules -Currently, the `PHI` normalizer supports rules defined in an unpublished paper by Yegor Bugayenko. +Currently, the `eo-phi-normalizer` supports rules defined in an unpublished paper by Yegor Bugayenko. ![Rules](../media/rules.jpg) ### yegor.yaml -These rules translated to `MetaPHI` are in [yegor.yaml](https://github.com/objectionary/normalizer/blob/master/eo-phi-normalizer/test/eo/phi/rules/yegor.yaml). +These rules translated to `MetaPHI` are in [yegor.yaml](https://github.com/objectionary/eo-phi-normalizer/blob/master/eo-phi-normalizer/test/eo/phi/rules/yegor.yaml). Each rule has the following structure: @@ -62,14 +62,14 @@ The commands in the following sections access files that are available in the pr ### `--help` ```$ as console -normalizer transform --help +eo-phi-normalizer transform --help ``` ```console -Usage: normalizer transform [-r|--rules FILE] [-c|--chain] [-j|--json] [--tex] - [-o|--output-file FILE] [-s|--single] - [--max-depth INT] [--max-growth-factor INT] [FILE] - [-d|--dependency-file FILE] +Usage: eo-phi-normalizer transform [-r|--rules FILE] [-c|--chain] [-j|--json] + [--tex] [-o|--output-file FILE] [-s|--single] + [--max-depth INT] [--max-growth-factor INT] + [FILE] [-d|--dependency-file FILE] Transform a PHI program. @@ -101,7 +101,7 @@ The output may contain multiple numbered results that correspond to different po (even if the final result is the same). ```$ as console -normalizer transform --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer transform --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -139,7 +139,7 @@ Result 1 out of 1: Use `--chain` to see numbered normalization steps for each normalization result. ```$ as console -normalizer transform --chain --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer transform --chain --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -175,7 +175,7 @@ Result 1 out of 1: ### `--json` ```$ as json -normalizer transform --json --chain --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer transform --json --chain --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```json @@ -195,7 +195,7 @@ normalizer transform --json --chain --rules ./eo-phi-normalizer/test/eo/phi/rule ### `--single` ```$ as console -normalizer transform --single --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer transform --single --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -215,7 +215,7 @@ normalizer transform --single --rules ./eo-phi-normalizer/test/eo/phi/rules/yego ### `--single` `--json` ```$ as console -normalizer transform --single --json --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi +eo-phi-normalizer transform --single --json --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml celsius.phi ``` ```console @@ -234,7 +234,7 @@ Can be used multiple times to inject multiple dependencies. ### `FILE` not specified (read from stdin) ```$ as console -cat celsius.phi | normalizer transform --single --json --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml +cat celsius.phi | eo-phi-normalizer transform --single --json --rules ./eo-phi-normalizer/test/eo/phi/rules/yegor.yaml ``` ```console diff --git a/site/docs/src/installation.md b/site/docs/src/installation.md index 9cbdcfcb5..1044c5b6b 100644 --- a/site/docs/src/installation.md +++ b/site/docs/src/installation.md @@ -4,24 +4,24 @@ - OS: `Ubuntu 22.04` or `macOS 12`. - `stack` is installable. -- `normalizer` is installable. +- `eo-phi-normalizer` is installable. ## Install `stack` {{#include ./common/install-stack.md}} -## Install `normalizer` +## Install `eo-phi-normalizer` -Install the `normalizer` executable globally via [stack](https://docs.haskellstack.org/en/stable). -Then, the `normalizer` executable will be available on `PATH`. +Install the `eo-phi-normalizer` executable globally via [stack](https://docs.haskellstack.org/en/stable). +Then, the `eo-phi-normalizer` executable will be available on `PATH`. -### Install `normalizer` from the repository +### Install `eo-phi-normalizer` from the repository {{#include ./common/enter-repository.md}} {{#include ./common/install.md}} -### Install `normalizer` from Hackage +### Install `eo-phi-normalizer` from Hackage ```sh stack update @@ -29,11 +29,11 @@ export LC_ALL=C.UTF-8 stack install --resolver lts-22.16 eo-phi-normalizer ``` -## Update `normalizer` +## Update `eo-phi-normalizer` Run `stack install ...` as in one of the methods above. -## Uninstall `normalizer` +## Uninstall `eo-phi-normalizer` Learn where `stack` installs programs. diff --git a/site/docs/src/introduction.md b/site/docs/src/introduction.md index 18f789c98..05b544fb4 100644 --- a/site/docs/src/introduction.md +++ b/site/docs/src/introduction.md @@ -4,12 +4,12 @@ Command line normalizer of \\( \varphi \\)-calculus expressions (as produced by Throughout the documentation, we refer to 𝜑-calculus as `PHI`. -This project aims to apply term rewriting techniques to "simplify" an input `PHI` expression and prepare it for further optimization passes. The simplification procedure will be a form of partial evaluation and normalization (see [normalizer transform](./normalizer/transform.md) and [normalizer dataize](./normalizer/dataize.md)). +This project aims to apply term rewriting techniques to "simplify" an input `PHI` expression and prepare it for further optimization passes. The simplification procedure will be a form of partial evaluation and normalization (see [eo-phi-normalizer transform](./eo-phi-normalizer/transform.md) and [eo-phi-normalizer dataize](./eo-phi-normalizer/dataize.md)). -Contrary to traditional normalization in λ-calculus, we aim at rewriting rules that would help reduce certain metrics of expressions (see [normalizer metrics](./normalizer/metrics.md)). +Contrary to traditional normalization in λ-calculus, we aim at rewriting rules that would help reduce certain metrics of expressions (see [eo-phi-normalizer metrics](./eo-phi-normalizer/metrics.md)). -See the [report](https://www.objectionary.com/normalizer/report) on our current progress with metrics. +See the [report](https://www.objectionary.com/eo-phi-normalizer/report) on our current progress with metrics. -The normalizer package is available on [Hackage](https://hackage.haskell.org/package/eo-phi-normalizer). +The eo-phi-normalizer package is available on [Hackage](https://hackage.haskell.org/package/eo-phi-normalizer). -The latest package [Haddock documentation](https://www.objectionary.com/normalizer/haddock) is available on our site. +The latest package [Haddock documentation](https://www.objectionary.com/eo-phi-normalizer/haddock) is available on our site. diff --git a/site/docs/src/metrics.md b/site/docs/src/metrics.md index e6bfa2cea..7ec3a9e8a 100644 --- a/site/docs/src/metrics.md +++ b/site/docs/src/metrics.md @@ -50,4 +50,4 @@ The following table demonstrates objects with their \\( \Delta \\)-depths: ## CLI command -See [normalizer metrics](./normalizer/metrics.md). +See [eo-phi-normalizer metrics](./eo-phi-normalizer/metrics.md). diff --git a/site/docs/src/normalizer/pipeline/print-dataize-configs.md b/site/docs/src/normalizer/pipeline/print-dataize-configs.md deleted file mode 100644 index c6f5311ea..000000000 --- a/site/docs/src/normalizer/pipeline/print-dataize-configs.md +++ /dev/null @@ -1,10 +0,0 @@ -# `normalizer pipeline print-dataize-configs` - -## `--config`, `--single-line`, `--strip-phi-prefix` - -This commands reads the [pipeline configuration](../../pipeline.md#pipeline-configuration) and prints configurations for the [normalizer dataize](../dataize.md). - -```sh -source scripts/lib.sh -normalizer pipeline print-dataize-configs --single-line --strip-phi-prefix "$PIPELINE_PHI_INITIAL_DIR_RELATIVE/" --config "$PIPELINE_CONFIG_FILE" -``` diff --git a/site/docs/src/pipeline.md b/site/docs/src/pipeline.md index 12e28b8d4..c06417ce6 100644 --- a/site/docs/src/pipeline.md +++ b/site/docs/src/pipeline.md @@ -8,7 +8,7 @@ {{ #include ./common/enter-repository.md }} -## Install `normalizer` +## Install `eo-phi-normalizer` {{ #include ./common/install.md }} @@ -69,15 +69,15 @@ The pipeline has several important stages: ### Pipeline configuration -The pipeline is configured via the [pipeline/config.yaml](https://github.com/objectionary/normalizer/blob/master/pipeline/config.yaml) file. +The pipeline is configured via the [pipeline/config.yaml](https://github.com/objectionary/eo-phi-normalizer/blob/master/pipeline/config.yaml) file. The configuration file specifies the following: - `report` - Pipeline report configuration. - `js` - Optional path to a `JavaScript` file that should be inlined into the `HTML` report. - - If no path is specified, `normalizer` will use [report/main.js](https://github.com/objectionary/normalizer/blob/master/eo-phi-normalizer/report/main.js). + - If no path is specified, `eo-phi-normalizer` will use [report/main.js](https://github.com/objectionary/eo-phi-normalizer/blob/master/eo-phi-normalizer/report/main.js). - `css` - Optional path to a `CSS` file that should be inlined into the `HTML` report. - - If no path is specified, `normalizer` will use [report/styles.css](https://github.com/objectionary/normalizer/blob/master/eo-phi-normalizer/report/styles.css). + - If no path is specified, `eo-phi-normalizer` will use [report/styles.css](https://github.com/objectionary/eo-phi-normalizer/blob/master/eo-phi-normalizer/report/styles.css). - `output` - Where to write report versions. - `html` - The file path of the `HTML` version. - `json` - The file path of the `JSON` version. diff --git a/site/docs/src/quick-start.md b/site/docs/src/quick-start.md index 0a3e1d7eb..ff2b09fe3 100644 --- a/site/docs/src/quick-start.md +++ b/site/docs/src/quick-start.md @@ -2,14 +2,14 @@ {{#include common/enter-repository.md}} -Install `normalizer` - see [Installation](./installation.md). +Install `eo-phi-normalizer` - see [Installation](./installation.md). {{#include common/celsius.md}} Dataize the program recursively. ```$ as console -normalizer dataize --recursive --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml \ +eo-phi-normalizer dataize --recursive --rules eo-phi-normalizer/test/eo/phi/rules/yegor.yaml \ --dependency-file 'eo-phi-normalizer/data/0.38.0/org/eolang/float.phi' \ --dependency-file 'eo-phi-normalizer/data/0.38.0/org/eolang/bytes.phi' \ celsius.phi