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

@nitro/exporter

v9.4.0

Published

An exporting package for nitro. Generate static packages with ease.

Downloads

987

Readme

npm version License Build Status

Nitro Exporter

With this package, Nitro can generate static exports of your project by using npm run export.

npm run export

Requirements

The gulp task "dump-views" must be present in your project.

Configuration options

The exporter configuration can be found in your config.

exporter.dest (String)

The export folder for your static export. This is where all your static files will go.

example: 'export'

exporter.i18n (Array)

Contains a list of language keys. The views will be exported using the specified language keys. (?lang=<lang>)

  • Using an empty array will export the default language
  • Use default for default language in an array with configured languages

example: ['de', 'default']

exporter.publics (Boolean / Array)

Controls which public files should be exported statically. true will export all files from your public directory.

You can define an array of strings, like ['public/assets/css/app.css', 'public/assets/js/app.js'] to export only those files.

When defining strings you can use globbing patterns.

example: ['public/*', 'public/assets/**/*', 'public/content/**/*']

exporter.renames (Array)

Defines file renames. Takes an array of objects with src, base and dest. Renaming is used with native gulp.src(...).pipe(gulp.dest(...)).

example:

[
    {
        src: 'export/assets/**',
        base: 'export/assets',
        dest: 'export/',
    },
]

exporter.replacements (Array)

Defines string replacements. Takes an array of objects with glob and replace. replace is an array of objects with keys from and to.

Please note: renames are executed before replacements!

example:

[
    {
        glob: ['export/*.html', 'export/css/*.css'],
        replace: [
            {
                from: '/assets',
                to: '',
            },
        ],
    },
]

exporter.views (Boolean / Array)

Controls which views should be exported statically. true will export all views from your views directory.

You can define an array of strings, like ['index', '404'] to export only those views.

When defining strings you can use globbing patterns.

example: true

exporter.additionalRoutes (Array)

Controls which additional routes should be exported.

example: ['api/service/countries.json', 'api/service/products.json']

exporter.minifyHtml

Defines, if the exported html pages should be minified.

example: false

exporter.zip

Defines, if the export should be zipped.

example: false

Example Exporter Config

"exporter": [
    {
        "dest": "export",
        "i18n": [],
        "publics": true,
        "renames": [
            {
                "src": "export/assets/**",
                "base": "export/assets",
                "dest": "export/"
            }
        ],
        "replacements": [
            {
                glob: ['export/*.html'],
                replace: [
                    {
                        from: '/assets/',
                        to: '',
                    },
                    {
                        from: '/content/',
                        to: 'content/',
                    },
                    {
                        from: ' href="/?([a-z0-9-]+)"',
                        to: ' href="$1.html"',
                    },
                ],
            },
            {
                glob: ['export/css/*.css'],
                replace: [
                    {
                        from: '/assets/',
                        to: '../',
                    },
                    {
                        from: '/content/',
                        to: '../content/',
                    },
                ],
            },
            {
                "glob": ["export/js/*.js"],
                "replace": [
                    {
                        from: '/assets/',
                        to: '',
                    },
                    {
                        "from": "/api",
                        "to": "api"
                    }
                ]
            },
        ],
        "views": true,
        "minifyHtml": false,
        "zip": false,
    }
]

Multiple Exporter configurations

You can define multiple exporter configuration objects, by setting the exporter to an array.

Example

exporter: [
    {
        dest: 'export',
        i18n: [],
        publics: true,
        renames: [],
        replacements: [],
        views: true,
        minifyHtml: false,
        zip: false,
    },
    {
        dest: 'static',
        i18n: [],
        publics: true,
        renames: [],
        replacements: [],
        views: true,
        minifyHtml: true,
        zip: false,
    },
]