Merge branch 'develop' into release/4.2

* develop: Add missing --project entry to Arguments listing Add IDs to dita command sections Move --output option to sort alphabetically Clarify options for disabling colored log output Use GNU-style double hyphen syntax for consistency Move no-color option to alpha sort; format to fix CI Migrate Husky to v9 Bump husky from 8.0.3 to 9.0.10 (#532) Bump gradle/wrapper-validation-action from 1 to 2 (#531) Bump actions/cache from 3 to 4 (#530) Bump peter-evans/create-pull-request from 5 to 6 (#529) Bump lint-staged from 15.2.0 to 15.2.1 (#527) Bump prettier from 3.1.1 to 3.2.4 (#526) Explain the -no-color parameter.
dita-ot · Feb 3, 2024 · 5de4e5e · 5de4e5e
2 parents 3b0ba22 + 64689b6
commit 5de4e5e
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 81 deletions.
diff --git a/.github/workflows/gradle-wrapper-validation.yml b/.github/workflows/gradle-wrapper-validation.yml
@@ -10,4 +10,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: gradle/wrapper-validation-action@v1
+      - uses: gradle/wrapper-validation-action@v2
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -29,7 +29,7 @@ jobs:
         uses: ./.github/actions/render
 
       - name: Cache NPM
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -47,7 +47,7 @@ jobs:
           rm -fr build
 
       - name: Cache gems
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -54,7 +54,7 @@ jobs:
         run: |
           curl -sL https://github.com/dita-ot/org.dita-ot.html/archive/refs/heads/${{ env.WEBSITE_PLUGIN_BRANCH }}.zip -o org.dita-ot.html.zip
       - name: Cache render DITA-OT
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: dita-ot-${{ env.DITA_OT_VERSION }}
           key: ${{ runner.os }}-dita-ot-${{ env.DITA_OT_VERSION }}
@@ -87,7 +87,7 @@ jobs:
           DITA_HOME: ${{ github.workspace }}/dita-ot-${{ env.DITA_OT_VERSION }}
           RELEASE_DITA_OT: ${{ github.workspace }}/src-dita-ot/dita-ot-${{ github.event.inputs.dita-ot-version }}
       - name: Create release PR
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           branch: release/${{ github.event.inputs.dita-ot-version }}
           title: 'Update site for ${{ github.event.inputs.dita-ot-version }}'
@@ -132,7 +132,7 @@ jobs:
           cmd: yq -i '.inputs.DITA_OT_VERSION.default = "${{ env.VERSION }}"' '.github/actions/render/action.yml'
 
       - name: Create release PR
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           branch: feature/update-github-actions-${{ env.VERSION }}
           title: 'Update docs GitHub Actions for ${{ env.VERSION }}'

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx lint-staged
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
     "fmt": "npm run format",
     "format": "prettier --write \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\"",
     "lint-staged": "lint-staged --no-stash",
-    "prepare": "husky install",
+    "prepare": "husky",
     "prettier": "prettier --write \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\"",
     "prettier-check": "prettier --check \"**/*.{css,dita*,json,md,scss,xml,yaml,yml}\"",
     "stylelint": "stylelint \"**/*.css\"",
@@ -46,9 +46,9 @@
   },
   "devDependencies": {
     "@prettier/plugin-xml": "3.2.2",
-    "husky": "^8.0.3",
-    "lint-staged": "15.2.0",
-    "prettier": "3.1.1",
+    "husky": "^9.0.10",
+    "lint-staged": "15.2.1",
+    "prettier": "3.2.4",
     "stylelint": "^15.11.0",
     "stylelint-config-recommended": "^13.0.0",
     "stylelint-config-sass-guidelines": "^10.0.0"

diff --git a/parameters/dita-command-arguments.dita b/parameters/dita-command-arguments.dita
@@ -112,7 +112,7 @@
         <parmname>--install</parmname> will still work.)</note>
     </section>
 
-    <section>
+    <section id="args">
       <title>Arguments</title>
       <indexterm><parmname>--input</parmname></indexterm>
       <indexterm><parmname>-i</parmname></indexterm>
@@ -150,10 +150,18 @@
             <p conkeyref="conref-task/transtypes"/>
           </pd>
         </plentry>
+        <plentry id="project">
+          <pt>
+            <parmname>--project</parmname>=<varname>file</varname>
+          </pt>
+          <pd>Publish a project file with multiple deliverables.</pd>
+          <pd>For more information, see
+            <xref keyref="using-project-files"/>.</pd>
+        </plentry>
       </parml>
     </section>
 
-    <section>
+    <section id="subcommands">
       <title>Subcommands</title>
       <indexterm><cmdname>deliverables</cmdname> subcommand</indexterm>
       <indexterm><cmdname>install</cmdname> subcommand</indexterm>
@@ -254,7 +262,7 @@
         </plentry>
       </parml>
     </section>
-    <section>
+    <section id="options">
       <title>Options</title>
       <indexterm><parmname>-o</parmname></indexterm>
       <indexterm><parmname>--output</parmname></indexterm>
@@ -288,22 +296,6 @@
             resources and can slow down the build process, so it should only be enabled when further details are
             required to diagnose problems.</pd>
         </plentry>
-        <plentry id="output">
-          <pt>
-            <parmname>--output</parmname>=<varname>dir</varname></pt>
-          <pt>
-            <parmname>-o</parmname>
-            <varname>dir</varname>
-          </pt>
-          <pd>
-            <p>Specifies the path of the output directory; the path can be absolute or relative to the current
-              directory.</p>
-            <p>This option corresponds to the common parameter
-              <xref keyref="parameters-base/output.dir"/>.</p>
-            <p>By default, the output is written to the <filepath>out</filepath> subdirectory of the current
-              directory.</p>
-          </pd>
-        </plentry>
         <plentry>
           <pt>
             <parmname>--filter</parmname>=<varname>files</varname>
@@ -342,6 +334,31 @@
           </pt>
           <pd>Write logging messages to a file.</pd>
         </plentry>
+        <plentry>
+          <pt>
+            <parmname>--no-color</parmname>
+          </pt>
+          <pd>By default, DITA-OT prints certain log messages to the console in color. In terminal environments that do
+            not support colored output, the ANSI color escape codes will be shown instead. To deactivate colored output,
+            pass the <parmname>--no-color</parmname> option to the <cmdname>dita</cmdname> command, or set the
+              <codeph>TERM=dumb</codeph> or <codeph>NO_COLOR</codeph> environment variables.</pd>
+        </plentry>
+        <plentry id="output">
+          <pt>
+            <parmname>--output</parmname>=<varname>dir</varname></pt>
+          <pt>
+            <parmname>-o</parmname>
+            <varname>dir</varname>
+          </pt>
+          <pd>
+            <p>Specifies the path of the output directory; the path can be absolute or relative to the current
+              directory.</p>
+            <p>This option corresponds to the common parameter
+              <xref keyref="parameters-base/output.dir"/>.</p>
+            <p>By default, the output is written to the <filepath>out</filepath> subdirectory of the current
+              directory.</p>
+          </pd>
+        </plentry>
         <plentry>
           <pt>
             <parmname>--parameter</parmname>=<varname>value</varname></pt>