You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{result: string,// either "success" or "failed"file: {path: string,// Path of the documentlines: Number,// Number of total lines processedsize: Number// filesize in bytes},issues: [{lines: Array<Number>,// start and end line number (starts at 1), e.g. [1,5]message: string,// error messageref: string,// optional link referencelevel: string// either "warn" or "error"},
...
]}
Web UI Mockup
The library could be integrated into a web app, allowing the user to browse for a document to validate. The document would be presented in a code editor like view, with warnings / errors shown on relevant lines (either inline or on the side).
This proposal is for a rewrite of idnits in javascript, so that it can run both natively in the browser and on the server / console.
General Implementation
checkNits(opts)
, that resolves to a result object.cli.js
parses command line arguments, calls the library and output the results in a console friendly format..json
file.Distribution
As a NPM package that can be both embedded into a web application or used as a standard CLI, on any platform supported by Node.js.
Arguments
Outdated
--version
--help
--nowarn
nowarn: false
--verbose
--nitcount
--debug
--year
year: 2023
--checklistwarn
--nonascii
noascii: false
--submitcheck
submitcheck: false
--status doctype
status: 'doctype'
See README.md instead.
Returns
Web UI Mockup
The library could be integrated into a web app, allowing the user to browse for a document to validate. The document would be presented in a code editor like view, with warnings / errors shown on relevant lines (either inline or on the side).
Breakdown of the Current Implementation
Original idnits SOW
idnits-SOW-00.pdf
The text was updated successfully, but these errors were encountered: