Data

Tools

Indexes

Applications

Experiments

Open Source Science

extra-jsdoc-text

Utilities for processing JSDoc text.

https://github.com/nodef/extra-jsdoc-text

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.1%) to scientific vocabulary

Keywords

extra jsdoc param-tag parse returns-tag stringify text
Last synced: 6 months ago · JSON representation ·

Repository

Utilities for processing JSDoc text.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
extra jsdoc param-tag parse returns-tag stringify text
Created almost 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

Utilities for processing JSDoc text.
📦 Node.js, 🌐 Web, 📜 Files, 📰 Docs.

This package is available in Node.js and Web formats. To use it on the web, simply use the extra_jsdoc_text global variable after loading with a <script> tag from the jsDelivr CDN.

Stability: Experimental.


```javascript const xjsdoc = require('extra-jsdoc-text');

function main() { var txt = /** * Parse jsdoc from jsdoc text. * @param txt jsdoc text * @returns parsed jsdoc */ , parse = null;

parse = xjsdoc.parse(txt); // { // full: '\n' + // '/**\n' + // ' * Parse jsdoc from jsdoc text.\n' + // ' * @param txt jsdoc text\n' + // ' * @returns parsed jsdoc\n' + // ' */\n' + // ' ', // description: 'Parse jsdoc from jsdoc text.\n', // params: [ // { // full: '@param txt jsdoc text', // name: 'txt', // type: '', // description: 'jsdoc text' // } // ], // returns: { // full: '@returns parsed jsdoc', // type: '', // description: 'parsed jsdoc' // }, // examples: [] // }

parse.description += ' (only if simple)'; xjsdoc.stringify(parse); // '/**\n' + // ' * Parse jsdoc from jsdoc text.\n' + // ' * (only if simple)\n' + // ' * @param txt jsdoc text\n' + // ' * @returns parsed jsdoc\n' + // ' * */\n' } main(); ```



Index

| Property | Description | | ---- | ---- | | parse | Parse jsdoc from jsdoc text. | | stringify | Stringify jsdoc text from parsed jsdoc. |




ORG DOI

Owner

  • Name: nodef
  • Login: nodef
  • Kind: organization

A summary of programs made with Node.js.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Sahu
    given-names: Subhajit
    orcid: https://orcid.org/0000-0001-5140-6578
title: "nodef/extra-jsdoc-text: Utilities for processing JSDoc text"
version: 0.1.10
doi: 10.5281/zenodo.6944487
date-released: 2022-07-31

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 14
  • Total Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Subhajit Sahu w****7@g****m 14

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • npm 73 last-month
  • Total dependent packages: 3
    (may contain duplicates)
  • Total dependent repositories: 15
    (may contain duplicates)
  • Total versions: 35
  • Total maintainers: 1
npmjs.org: extra-jsdoc-text

Utilities for processing JSDoc text.

  • Versions: 18
  • Dependent Packages: 2
  • Dependent Repositories: 15
  • Downloads: 51 Last month
Rankings
Dependent repos count: 3.1%
Dependent packages count: 8.8%
Downloads: 11.9%
Average: 12.0%
Forks count: 15.4%
Stargazers count: 20.9%
Maintainers (1)
wolfram77
Last synced: 6 months ago
npmjs.org: extra-jsdoc-text.web

Utilities for processing JSDoc text{web}.

  • Versions: 17
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 22 Last month
Rankings
Dependent packages count: 16.2%
Downloads: 16.7%
Forks count: 20.5%
Average: 21.2%
Dependent repos count: 25.3%
Stargazers count: 27.1%
Maintainers (1)
wolfram77
Last synced: 6 months ago

Dependencies

package-lock.json npm
  • @babel/code-frame 7.16.7 development
  • @babel/helper-validator-identifier 7.16.7 development
  • @babel/highlight 7.16.10 development
  • @octokit/auth-token 3.0.0 development
  • @octokit/core 4.0.4 development
  • @octokit/endpoint 7.0.0 development
  • @octokit/graphql 5.0.0 development
  • @octokit/openapi-types 12.11.0 development
  • @octokit/plugin-paginate-rest 3.1.0 development
  • @octokit/plugin-request-log 1.0.4 development
  • @octokit/plugin-rest-endpoint-methods 6.2.0 development
  • @octokit/request 6.2.0 development
  • @octokit/request-error 3.0.0 development
  • @octokit/rest 19.0.3 development
  • @octokit/types 6.41.0 development
  • @rollup/plugin-commonjs 22.0.1 development
  • @rollup/plugin-node-resolve 13.3.0 development
  • @rollup/pluginutils 3.1.0 development
  • @types/estree 0.0.39 development
  • @types/node 18.6.2 development
  • @types/resolve 1.17.1 development
  • ansi-styles 3.2.1 development
  • balanced-match 1.0.2 development
  • before-after-hook 2.2.2 development
  • brace-expansion 2.0.1 development
  • brace-expansion 1.1.11 development
  • builtin-modules 3.3.0 development
  • chalk 2.4.2 development
  • color-convert 1.9.3 development
  • color-name 1.1.3 development
  • commondir 1.0.1 development
  • concat-map 0.0.1 development
  • deepmerge 4.2.2 development
  • deprecation 2.3.1 development
  • escape-string-regexp 1.0.5 development
  • estree-walker 1.0.1 development
  • estree-walker 2.0.2 development
  • estree-walker 0.6.1 development
  • extra-build 2.2.21 development
  • extra-javascript-text 0.1.11 development
  • extra-jsdoc-text 0.1.9 development
  • extra-markdown-text 0.1.0 development
  • fs.realpath 1.0.0 development
  • fsevents 2.3.2 development
  • function-bind 1.1.1 development
  • glob 7.2.0 development
  • has 1.0.3 development
  • has-flag 3.0.0 development
  • inflight 1.0.6 development
  • inherits 2.0.4 development
  • is-builtin-module 3.1.0 development
  • is-core-module 2.8.1 development
  • is-module 1.0.0 development
  • is-plain-object 5.0.0 development
  • is-reference 1.2.1 development
  • js-cleanup 1.2.0 development
  • js-tokens 4.0.0 development
  • jsonc-parser 3.1.0 development
  • kleur 4.1.5 development
  • lru-cache 6.0.0 development
  • lunr 2.3.9 development
  • magic-string 0.25.9 development
  • magic-string 0.26.1 development
  • marked 4.0.18 development
  • minimatch 5.1.0 development
  • minimatch 3.1.2 development
  • node-fetch 2.6.7 development
  • once 1.4.0 development
  • path-is-absolute 1.0.1 development
  • path-parse 1.0.7 development
  • perf-regexes 1.0.1 development
  • picomatch 2.3.1 development
  • resolve 1.22.0 development
  • rollup 2.70.1 development
  • rollup-plugin-cleanup 3.2.1 development
  • rollup-plugin-dts 4.2.2 development
  • rollup-pluginutils 2.8.2 development
  • semver 7.3.7 development
  • shiki 0.10.1 development
  • skip-regex 1.0.2 development
  • sourcemap-codec 1.4.8 development
  • supports-color 5.5.0 development
  • supports-preserve-symlinks-flag 1.0.0 development
  • tr46 0.0.3 development
  • typedoc 0.23.9 development
  • typescript 4.6.3 development
  • universal-user-agent 6.0.0 development
  • vscode-oniguruma 1.6.2 development
  • vscode-textmate 5.2.0 development
  • webidl-conversions 3.0.1 development
  • whatwg-url 5.0.0 development
  • wrappy 1.0.2 development
  • yallist 4.0.0 development
package.json npm
  • @rollup/plugin-commonjs ^22.0.1 development
  • @rollup/plugin-node-resolve ^13.3.0 development
  • @types/node ^18.6.2 development
  • extra-build ^2.2.21 development
  • rollup-plugin-cleanup ^3.2.1 development
  • rollup-plugin-dts ^4.2.2 development
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v2 composite
.github/workflows/pr.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v2 composite