# jul-comments > JCS - JUL Comment System Latest version **1.5.9** (published 2020-03-24) · LGPL-3.0 license · 0 weekly downloads ## Install ```sh npm install jul-comments pnpm add jul-comments yarn add jul-comments bun add jul-comments ``` Provides the command `jul-comments`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.5.9 | | Published | 2020-03-24 | | First published | 2017-07-27 | | Weekly downloads | 0 | | License | LGPL-3.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 18 | | Unpacked size | 3.5 MB | | Known vulnerabilities | 0 (+6 in 2 direct dependencies) | | Install scripts | no | | Author | The Zonebuilder | | Maintainers | zonebuilder | | Keywords | UI, builder, visual | ## Links - npm: https://www.npmjs.com/package/jul-comments - Repository: https://github.com/zonebuilder/jul-comments - Homepage: https://github.com/zonebuilder/jul-comments#readme - Issues: https://github.com/zonebuilder/jul-comments/issues - npm.io page: https://npm.io/package/jul-comments ## Dependencies (18) - [cli](https://npm.io/package/cli.md) 1.x - [ejs](https://npm.io/package/ejs.md) 2.x - [jul](https://npm.io/package/jul.md) 1.x - [gulp](https://npm.io/package/gulp.md) 3.x - [pump](https://npm.io/package/pump.md) 1.x - [express](https://npm.io/package/express.md) 3.x - [gulp-if](https://npm.io/package/gulp-if.md) 2.x - [fs-extra](https://npm.io/package/fs-extra.md) 1.x - [gulp-newer](https://npm.io/package/gulp-newer.md) 1.x - [gulp-unzip](https://npm.io/package/gulp-unzip.md) 0.x - [zip-stream](https://npm.io/package/zip-stream.md) 1.x - [body-parser](https://npm.io/package/body-parser.md) 1.x - [gulp-concat](https://npm.io/package/gulp-concat.md) 2.x - [gulp-header](https://npm.io/package/gulp-header.md) 1.x - [gulp-ignore](https://npm.io/package/gulp-ignore.md) 2.x - [gulp-uglify](https://npm.io/package/gulp-uglify.md) 2.x - [gulp-clean-css](https://npm.io/package/gulp-clean-css.md) 2.x - [gulp-load-plugins](https://npm.io/package/gulp-load-plugins.md) 1.x ## Alternatives - [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads - [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads - [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads - [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads - [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads ## Recent versions - 1.5.9 (latest) — 2020-03-24 - 1.5.8 — 2020-02-10 - 1.5.0 — 2018-12-10 - 1.3.8 — 2018-06-30 - 1.3.7 — 2018-06-21 - 1.3.6 — 2017-09-01 - 1.3.5 — 2017-07-27 ## README

JUL

JCS - JUL Comment System ======================== About ----- JCS - JUL Comment System is a way of documenting your JavaScript source code while keeping the comments in a separate file. It allows you to associate the comments to any version of the source code and to get the updated commented code. Also, JCS is able to generate and to document the code for an entire JavaScript namespace or DOM tree loaded by a web page. License ------- Licensed under GNU GPLv2 or later and under GNU LGPLv3 or later. See enclosed 'licenses' folder. Features -------- * generates documented code from JavaScript source code or from runtime code * saves the comments as a separate project for reuse and management of documenting different versions of the code * recognizes types of data and generates comments blocks accordingly * splits a JavaScript namespace into a custom number of child namespaces as documented source files with their corresponding code * downloading the collection of generated source files as a zip package System requirements ------------------- You may download the desktop application OR: * a CSS2 compliant web browser with JavaScript 1.5 or later engine * Node.js 0.10.0 or later installed * OR a web server with PHP 5.2.0 or later extension * 1024x768 minimum resolution Install & usage in Node ----------------------- Install & run locally for Linux/UNIX shells: ```bash npm install jul-comments "$(npm bin)/jul-comments" ``` Install & run locally for Windows/DOS shells: ```cmd npm install jul-comments for /f "tokens=*" %i in ('npm bin') do @"%i\jul-comments" ``` Install JCS globally: `npm install -g jul-comments` Run server application: `jul-comments`. Use `-h` switch to see more options. Use a browser to work with the app at `http://localhost:7780/`. By default, the generated code is compatible with `module.exports` and can be required in a Node script. Build & install from source --------------------------- Install [Node.js](https://nodejs.org/) and [Git](https://git-scm.com/) command line in your system. Run the following shell commands in order: ``` bash npm install npm run deps npm run make ``` The release will be in the 'build' folder. The Node module will be in the 'build_node' folder. Downloads & user support ------------------------ [jul-comments project on SourceForge](http://sourceforge.net/projects/jul-comments/) --- _Source: https://npm.io/package/jul-comments · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._