Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/lekhmanrus/esbuild-pug

esbuild plugin to work with pug (jade) files

https://github.com/lekhmanrus/esbuild-pug

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

build-tool build-tools esbuild esbuild-loader esbuild-plugin esbuild-plugins hacktoberfest html-template html-template-engine jade javascript plugin plugins pug pugjs typescript
Last synced: 6 months ago · JSON representation

Repository

esbuild plugin to work with pug (jade) files

Basic Info
  • Host: GitHub
  • Owner: lekhmanrus
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 101 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
build-tool build-tools esbuild esbuild-loader esbuild-plugin esbuild-plugins hacktoberfest html-template html-template-engine jade javascript plugin plugins pug pugjs typescript
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

esbuild-pug

esbuild-pug logo
esbuild plugin to work with pug (jade) files.

Build Publish codecov npm version npm

Features

  • Compiles .pug and .jade files
  • Supports various configuration file formats
  • Integrates with esbuild seamlessly

Installation

sh npm install --save-dev esbuild-pug

Usage

```ts import { build } from 'esbuild'; import { pugPlugin } from 'esbuild-pug';

build({ entryPoints: [ 'app.js' ], bundle: true, outfile: 'out.js', plugins: [ pugPlugin() ], }) .catch(() => process.exit(1)); ```

Configuration

You can configure the plugin by passing options:

ts pugPlugin({ basedir: './src/', // other pug options })

Options

You can configure your project to pass the additional options.

The plugin accepts all standard Pug options, plus:

  • root: Set the root directory for resolving includes and extends.
  • loader: Choose between text (default) or js output.

You can see the supported options here.

Configuration File Formats

esbuild-pug supports configuration files in several formats:

  • JavaScript - use .pugrc.js or pug.config.js and export an object containing your configuration.
  • YAML - use .pugrc, .pugrc.yaml or .pugrc.yml to define the configuration structure.
  • JSON - use .pugrc.json to define the configuration structure.
  • package.json - create an pugConfig property in your package.json file and define your configuration there.

If there are multiple configuration files in the same directory, esbuild-pug will only use one. The priority order is as follows:

  1. package.json
  2. .pugrc
  3. .pugrc.json
  4. .pugrc.yaml
  5. .pugrc.yml
  6. .pugrc.js
  7. .pugrc.cjs
  8. pug.config.js
  9. pug.config.cjs

Using Configuration Files

Here's an example configuration file that sets Pug basedir option (again, see whole list of supported options here): * .pugrc.json (JSON) json { "basedir": "./src/" }

  • .pugrc (YAML) yaml basedir: ./src/

  • pug.config.js (JavaScript) js module.exports = { basedir: './src/' };

P.S.: Either of that should work. No need to create all of them. See Configuration File Formats.

Build

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Owner

  • Name: Ruslan Lekhman
  • Login: lekhmanrus
  • Kind: user
  • Location: Edmonton, AB, Canada

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 5 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
npmjs.org: esbuild-pug

esbuild plugin to work with pug (jade) files

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 5 Last month
Rankings
Downloads: 20.1%
Dependent repos count: 25.7%
Average: 27.7%
Dependent packages count: 37.3%
Maintainers (1)
lekhmanrus
Last synced: 6 months ago