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

glass-easel-miniprogram-webpack-plugin

v0.10.3

Published

The webpack plugin of the glass-easel project for MiniProgram file structure

Downloads

138

Readme

glass-easel-miniprogram-webpack-plugin

The webpack plugin for building mini-program code running in glass-easel.

Refer to the glass-easel project for further details.

Usage

See the template.

The GlassEaselMiniprogramWxmlLoader loader must be added to handle .wxml files, and the GlassEaselMiniprogramWxssLoader loader must be added to handle .wxss files. They can work with other loaders.

{
  test: /\.wxml$/,
  use: GlassEaselMiniprogramWxmlLoader,
  exclude: /node_modules/,
},
{
  test: /\.wxss$/,
  use: [
    'css-loader',
    GlassEaselMiniprogramWxssLoader,
  ],
  exclude: /node_modules/,
},

Furthurmore, a webpack plugin that compiles a mini-program-like directory structure should be added. The directory should be specified in the plugin options.

plugins: [
  new GlassEaselMiniprogramWebpackPlugin({
    path: path.join(__dirname, 'src'),
    resourceFilePattern: /\.(jpg|jpeg|png|gif|html)$/,
    defaultEntry: 'pages/index/index',
  }),
],

| Options | Explanation | | ------- | ----------- | | dev | compile with more debug information (default to false if the webpack is in production mode) | | path | the mini-program-like directory to be compiled (default to src ) | | resourceFilePattern | the filename pattern (in the mini-program-like directory) to be copied into the webpack output path | | defaultEntry | the mini-program page to be loaded on startup | | customBootstrap | (see the Custom Bootstrap section below) | | disableClassPrefix | (see the Custom Bootstrap section below) |

The plugin will generate a virtual index.js file in the mini-program-like directory (a.k.a. src/index.js by default). This file can be used as the webpack entry or be imported by other modules.

Custom Bootstrap

By default, the plugin inserts a bootstrap code to insert the defaultEntry into DOM <body>

However, if the backend is not DOM or you want to bootstrap manually, set the customBootstrap option to true .

new GlassEaselMiniprogramWebpackPlugin({
  customBootstrap: true,
})

Furthermore, if the backend handles stylesheets unlike DOM, another disableClassPrefix may be required to be true depending on the backend.

When using custom bootstrap, the plugin will generate a module which has the following types:

import type * as adapter from 'glass-easel-miniprogram-adapter'

export declare const env: adapter.MiniProgramEnv
export declare const codeSpace: adapter.CodeSpace
export declare const registerGlobalEventListener: (
  backend: adapter.glassEasel.GeneralBackendContext,
) => void
export declare const initWithBackend: (
  backend: adapter.glassEasel.GeneralBackendContext,
) => adapter.AssociatedBackend

You can put the code above into a d.ts file ( src.d.ts by default).

A page can be loaded like this:

import * as glassEasel from 'glass-easel'
import { codeSpace, initWithBackend, registerGlobalEventListener } from './src' // import the plugin-generated code

// create the backend context
const backendContext = new glassEasel.CurrentWindowBackendContext() // or another backend context
registerGlobalEventListener(backendContext)
const ab = initWithBackend(backendContext)

// create a mini-program page
const root = ab.createRoot(
  'glass-easel-root', // the tag name of the mount point
  codeSpace,
  'pages/index/index', // the mini-program page to load
)

// insert the page into backend
// (this step is backend-related - if the backend is not DOM, refer to the backend documentation)
const placeholder = document.createElement('span')
document.body.appendChild(placeholder)
root.attach(
  document.body as unknown as glassEasel.GeneralBackendElement,
  placeholder as unknown as glassEasel.GeneralBackendElement,
)