summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/expltools/CHANGES.md49
-rw-r--r--Master/texmf-dist/doc/support/expltools/README.md11
-rw-r--r--Master/texmf-dist/doc/support/expltools/project-proposal.pdfbin67243 -> 67243 bytes
-rw-r--r--Master/texmf-dist/doc/support/expltools/warnings-and-errors-01-preprocessing.md2
-rw-r--r--Master/texmf-dist/doc/support/expltools/warnings-and-errors.pdfbin2780970 -> 2780784 bytes
5 files changed, 55 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/support/expltools/CHANGES.md b/Master/texmf-dist/doc/support/expltools/CHANGES.md
index b63171ff6f6..135f8dce324 100644
--- a/Master/texmf-dist/doc/support/expltools/CHANGES.md
+++ b/Master/texmf-dist/doc/support/expltools/CHANGES.md
@@ -1,5 +1,54 @@
# Changes
+## expltools 2025-01-15
+
+### explcheck v0.5.0
+
+#### Development
+
+- Add support for ignoring file-wide issues and issues on a single line using
+ TeX comments. (#23)
+
+ For example, a comment `% noqa` will ignore any issues on the current line,
+ whereas a comment `% noqa: W100, S206` will ignore the file-wide warning W100
+ (No standard delimiters) and the warning S206 (Malformed variable or constant
+ name) on the current line.
+
+- Add command-line option `--ignored-issues` and Lua option `ignored_issues`
+ for ignoring issues. (#23)
+
+ For example, `--ignored-issues=w100,s206` will ignore the file-wide warning
+ W100 (No standard delimiters) and all warnings S206 (Malformed variable or
+ constant name).
+
+#### Fixes
+
+- Correctly shorten long names of files from the current working directory in
+ the command-line output. (#23)
+
+- Correctly parenthesize and order LPEG parsers in the file
+ `explcheck-obsolete.lua`. (#23)
+
+- Do not produce warning S204 (Missing stylistic whitespaces) for non-expl3,
+ empty, or one-character names of control sequences. (#23)
+
+- Do not produce warning S204 (Missing stylistic whitespaces) for an empty
+ grouping (`{}`). (#23)
+
+- Do not produce warning S204 (Missing stylistic whitespaces) for a parameter
+ before begin grouping (`#1{`). (#23)
+
+- Do not produce S204 (Missing stylistic whitespaces) for a comma immediately
+ after a control sequence. (505608f9)
+
+- Do not produce warnings S205 (Malformed function name) and S206 (Malformed
+ variable or constant name) for non-expl3 functions, variables, and constants.
+ (#23)
+
+- Do not produce warnings S206 (Malformed variable or constant name) for
+ variable and constant names that contain names of built-in types such as
+ `\c_module_constant_clist_tl` containing `clist`. (#23)
+
## expltools 2025-01-14
### explcheck v0.4.0
diff --git a/Master/texmf-dist/doc/support/expltools/README.md b/Master/texmf-dist/doc/support/expltools/README.md
index 08bd113d004..96ddfc22eba 100644
--- a/Master/texmf-dist/doc/support/expltools/README.md
+++ b/Master/texmf-dist/doc/support/expltools/README.md
@@ -12,7 +12,7 @@ The full text of the project proposal, which summarizes devlog posts 1–4 is av
These devlog posts chronicle the latest updates and progress in the ongoing development of the tool:
-5. [Frank Mittelbach in Brno, the first public release of explcheck, and expl3 usage statistics][8] from December 5, 2024
+5. [Frank Mittelbach in Brno, first public release of explcheck, and expl3 usage statistics][8] from Dec 5, 2024
6. [A flurry of releases, CSTUG talk, and what's next][9] from December 19, 2024
In the future, this repository may also contain the code of other useful development tools for expl3 programmers, such as a command-line utility similar to `grep` that will ignore whitespaces and newlines as well as other tools.
@@ -57,12 +57,11 @@ local file = assert(io.open(filename, "r"))
local content = assert(file:read("*a"))
assert(file:close())
-local line_starting_byte_numbers, expl_ranges = preprocessing(issues, content)
-local tokens = lexical_analysis(issues, content, expl_ranges)
+local _, expl_ranges = preprocessing(issues, content)
+lexical_analysis(issues, content, expl_ranges)
print(
- "There were " .. #tokens .. " tokens, "
- .. #issues.warnings .. " warnings, "
+ "There were " .. #issues.warnings .. " warnings, "
.. "and " .. #issues.errors .. " errors "
.. "in the file " .. filename .. "."
)
@@ -89,7 +88,7 @@ jobs:
You can prepare the expltools bundle for distribution with the following two commands:
-1. `l3build tag`: Add the current version numbers to the file `explcheck-lua.cli`.
+1. `l3build tag`: Add version numbers to file `explcheck-cli.lua` and create `explcheck-obsolete.lua`.
2. `l3build ctan`: Run tests, build the documentation, and create a CTAN archive `expltools-ctan.zip`.
The file `explcheck.lua` should be installed in the TDS directory `scripts/expltools/explcheck`. Furthermore, it should be made executable and either symlinked to system directories as `explcheck` on Unix or have a wrapper `explcheck.exe` installed on Windows.
diff --git a/Master/texmf-dist/doc/support/expltools/project-proposal.pdf b/Master/texmf-dist/doc/support/expltools/project-proposal.pdf
index 10c6dd8b45f..dab1d058fb8 100644
--- a/Master/texmf-dist/doc/support/expltools/project-proposal.pdf
+++ b/Master/texmf-dist/doc/support/expltools/project-proposal.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/expltools/warnings-and-errors-01-preprocessing.md b/Master/texmf-dist/doc/support/expltools/warnings-and-errors-01-preprocessing.md
index 965156dbc8b..3eeff7e449a 100644
--- a/Master/texmf-dist/doc/support/expltools/warnings-and-errors-01-preprocessing.md
+++ b/Master/texmf-dist/doc/support/expltools/warnings-and-errors-01-preprocessing.md
@@ -21,7 +21,7 @@ Some lines in expl3 parts are longer than 80 characters [@latexteam2024style, Se
/s103.tex
-The maximum line length can be configured using the command-line option `--max-line-length` or with the parameter `max_line_length` of the function returned by the Lua module `explcheck-preprocessing`.
+The maximum line length can be configured using the command-line option `--max-line-length` or with the Lua option `max_line_length`.
## Multiple delimiters `\ProvidesExpl*` in a single file {.e label=e104}
An input file contains multiple delimiters `\ProvidesExplPackage`, `\ProvidesExplClass`, and `\ProvidesExplFile`.
diff --git a/Master/texmf-dist/doc/support/expltools/warnings-and-errors.pdf b/Master/texmf-dist/doc/support/expltools/warnings-and-errors.pdf
index 6f291b78cc4..3d90203727f 100644
--- a/Master/texmf-dist/doc/support/expltools/warnings-and-errors.pdf
+++ b/Master/texmf-dist/doc/support/expltools/warnings-and-errors.pdf
Binary files differ