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

@lighting-beetle/next-lighter-config

v0.2.0

Published

Custom Next.js config designed for building pages without Next.js runtime.

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

jurajkjurajkadam.mockoradam.mockorbenjamin.starybenjamin.stary

Keywords

Readme

@lighting-beetle/next-lighter-config

Custom Next.js config designed for building pages without Next.js runtime.

Quick Start

// next.config.js
const nextLighterConfig = require("@lighting-beetle/next-lighter-config");
const { extend } = require("next-compose-plugins");

module.exports = extend(nextLighterConfig()).withPlugins([]);

Features

  • MDX with frontMatter support
  • CSS/SCSS
  • Typescript props documentation for React components
  • Compile custom entries with Next.js webpack

Options

// next.config.js
const nextLighterConfig = require("@lighting-beetle/next-lighter-config");
const { extend } = require("next-compose-plugins");

module.exports = extend(nextLighterConfig(/* { ...options } */)).withPlugins([
  /* ...other nextjs plugins (see next-compose-plugins) */
]);

tsConfigPath

string | defaults to ../../tsconfig.json

Path to tsconfig file, which is used to process Typescript files.

componentsPath

string/array[string] | (defaults to ../components)

Path to Typescript React components for generating documentation with react-docgen-typescript.

staticEntriesMap

`{ ['entryName']: 'entry path'} | undefined

Map of static (non-react) entries which should be processed by Next.js webpack.

Static scope - pages without Next.js runtime (React)

This project support Next.js exported pages which don't have Next.js runtime. Instead of that we run our own entires on these pages. This creates ability to build static pages from React components without dynamic behavior of the components (e.g. no React hooks).

To pass our entries to Next.js webpack we are using @lighting-beetle/next-lighter-config config option staticEntriesMap.

// next.config.js
const nextLighterConfig = require("@lighting-beetle/next-lighter-config");
const { extend } = require("next-compose-plugins");

module.exports = extend(
  nextLighterConfig({
    staticEntriesMap: { static: "../components/src/static.ts" },
  })
).withPlugins([]);

Static pages needs to be defined in custom-pages.ts file like on example in the root of src folder.

// custom-pages.ts
const customPages: customPages = {
  "/static": { nextRuntime: false, scripts: ["static.js"] },
};

export default customPages;

Implementation of static scope

  1. We took static pages declared in custom-pages.ts.
  2. Custom webpack entry is added in next.config.js by staticEntriesMap of @lighting-beetle/next-lighter-config and custom-entries-build-manifest.json is created to get filename with hash of this entries in production or without hash in development.
  3. pages/_document.tsx adds replace Next.js runtime <Head /> and <NextScripts /> with <StaticHead /> and <CustomScripts /> (if scripts are defined) on pages with nextRuntime: false flag.
  4. Force next/router in pages/_app.tsx to reload page without Next.js runtime to make sure that we have correct document displayed in browser.

Issues with no Next.js runtime

  • Static pages don't support live reloading.
  • We share polyfill file with React scope.
  • Not sure if custom entries are polyfilled at all.