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

jsarch

v6.1.0

Published

A simple module to extract architecture notes from your code.

Downloads

602

Readme

jsarch

A simple module to extract architecture notes from your code.

GitHub license

Usage

To generate any project's architecture notes:

jsarch src/*.js > ARCHITECTURE.md

Configuration

You can set your own configuration by adding a jsarch property in your package.json file (see the defaults).

For example, if you which to have TypeScript support and you use Gitlab instead of GitHub, just add this:

{
    // (...)
    "jsarch": {
        "gitProvider": "bitbucket",
        "parserOptions": {
          "plugins": ["typescript"]
        }
    }
    // (...)
}

Per default, the Babel parser is used, but you can change it with the parser option. You'll have to install it before using it.

Develoment

To get involved into this module's development:

npm i -g jsarch

git clone [email protected]:nfroidure/jsarch.git

cd jsarch

npm it
npm run build

node bin/jsarch **/*.js > ARCHITECTURE.md

Architecture Notes

You can see this repository architecture notes for an example of the kind of content generated by this module.

API

initJSArch(services) ⇒ Promise.<function()>

Declare jsArch in the dependency injection system

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | services | Object | | Services (provided by the dependency injector) | | services.CONFIG | Object | | The JSArch config | | services.EOL | Object | | The OS EOL chars | | services.glob | Object | | Globbing service | | services.fs | Object | | File system service | | services.parser | Object | | Parser service | | [services.log] | Object | noop | Logging service |

initJSArch~jsArch(options) ⇒ Promise.<String>

Compile an run a template

Kind: inner method of initJSArch
Returns: Promise.<String> - Computed architecture notes as a markdown file

| Param | Type | Description | | --- | --- | --- | | options | Object | Options (destructured) | | options.cwd | Object | Current working directory | | options.patterns | Object | Patterns to look files for (see node-glob) | | options.eol | Object | End of line character (default to the OS one) | | options.titleLevel | Object | The base title level of the output makdown document | | options.base | Object | The base directory for the ARCHITECTURE.md references |

Authors

License

MIT