How to use jsdoc-parse - 2 common examples

To help you get started, we’ve selected a few jsdoc-parse examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github algolia / react-instantsearch / docgen / plugins / jsdoc-data.js View on Github external
} else {
          files[buildFilename] = cachedFiles[buildFilename];
        }
      });
    } else {
      cachedFiles = {};
    }

    allFilles.forEach(({ filename }) => delete files[`${filename}.jsdoc`]);

    if (filesToParse.length === 0) {
      done();
      return;
    }

    jsdocParse({
      src: filesToParse,
      json: true,
    }).pipe(collectJson(dataReady));

    function dataReady(unfilteredSymbols) {
      const symbolsByCategory = groupBy(
        unfilteredSymbols.filter(
          o =>
            !o.deprecated &&
            o.kind &&
            (o.kind === 'component' ||
              o.kind === 'widget' ||
              o.kind === 'connector' ||
              o.kind === 'server-side-rendering')
        ),
        'kind'
github algolia / vue-instantsearch / docs / plugins / jsdoc-data.js View on Github external
} else {
          files[buildFilename] = cachedFiles[buildFilename];
        }
      });
    } else {
      cachedFiles = {};
    }

    allFilles.forEach(({filename}) => delete files[`${filename}.jsdoc`]);

    if (filesToParse.length === 0) {
      done();
      return;
    }

    jsdocParse({
      src: filesToParse,
      json: true,
    }).pipe(collectJson(dataReady));

    function dataReady(unfilteredSymbols) {
      const symbolsByCategory = groupBy(
        unfilteredSymbols.filter(
          o => !o.deprecated &&
            o.kind &&
            (o.kind === 'component' || o.kind === 'widget' || o.kind === 'connector')
        ),
        'kind'
      );

      forEach(symbolsByCategory, symbols => {
        forEach(symbols, data => {

jsdoc-parse

Transforms jsdoc data into something more suitable for use as template input

MIT
Latest version published 5 months ago

Package Health Score

72 / 100
Full package analysis

Popular jsdoc-parse functions