npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsdoc-file

v1.1.0

Published

JSDoc plugin to create files inside directory of generated documentation (e.g. .nojekyll etc)

Downloads

12

Readme

jsdoc-file

JSDoc plugin to create files inside directory of generated documentation (e.g. .nojekyll etc).

Table of contents

Installation

npm install jsdoc-file --save-dev

This plugin requires the following:

  • JSDoc version >= 3.2.1

Usage

  1. Add plugin into plugins array of a JSDoc configuration file:
{
    ...
    "plugins": [
        ...
        "jsdoc-file"
    ],
    ...
}
  1. Specify files that should be created as value of opts.fileSet field in the JSDoc configuration file:
{
    "opts": {
        ...
        "fileSet": {
            ".nojekyll": "",
            "LICENSE-MIT": "Copyright (c) ..."
        }
    },
    ...
}

You can specify one or several files and provide content for them.
If a file does already exist in documentation directory the file will be overwritten.
It is possible to set file path that includes subdirectories inside documentation directory (necessary subdirectories will be automatically created).
You can skip creation of a file by setting false/null value for the file.
If you set an object or an array as a value for a file the corresponding JSON will be written into the file.
See examples below.

Examples

In the following examples "opts": {...} is omitted for brevity.

Create one empty file:

"fileSet": ".nojekyll"

or

"fileSet":  {
    ".nojekyll": ""
}

or

"fileSet":  {
    ".nojekyll": true
}

Create several files at once:

"fileSet":  {
    ".nojekyll": true,
    "LICENSE": "Some license data here",
    "very/important/file.txt": "very important data",
    "config.json": {
        "a": 2,
        "topics": ["home", "docs"],
        "url": "http://some.server.net"
    }
}

Skip creating some files by setting false/null value for them:

"fileSet":  {
    ".nojekyll": false,
    "a.txt": "content",
    "some/dir/file.md": null
}

Related projects

  • makef - a utility to create files inside specified directory.
  • typedoc-light-theme - TypeDoc theme that adds some useful options (header links, custom style and script, ability to create files etc).

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

License

Copyright (c) 2020-2021 Denis Sikuler
Licensed under the MIT license.