Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henrycatalinismith/11tyshim
Eleventy monkeypatch plugin for shimming lifecycle events
https://github.com/henrycatalinismith/11tyshim
11ty 11ty-plugin monkey-patching shim
Last synced: 5 days ago
JSON representation
Eleventy monkeypatch plugin for shimming lifecycle events
- Host: GitHub
- URL: https://github.com/henrycatalinismith/11tyshim
- Owner: henrycatalinismith
- License: mit
- Created: 2021-04-26T19:03:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-01T18:35:15.000Z (about 1 year ago)
- Last Synced: 2024-04-26T21:20:50.847Z (8 months ago)
- Topics: 11ty, 11ty-plugin, monkey-patching, shim
- Language: TypeScript
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: license
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
Eleventy monkeypatch plugin
> [!NOTE]
> In version 1.0.0 of Eleventy, an event listener API was added to eleventyConfig.
> You're better off using that API rather than this plugin.
>
> https://www.11ty.dev/docs/events/
Need to monkeypatch Eleventy to listen to lifecycle events for your plugin?
Need access to `eleventyInstance` so you can read config variables or reload
the dev server? Tired of copypasting around that same `monkeypatch()` function
everyone else is using? This is the plugin you're looking for!
## Installation
```
yarn add -D @henrycatalinismith/11tyshim
```
## Usage
```javascript
const { shimPlugin } = require("@henrycatalinismith/11tyshim")
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(shimPlugin, {
finish: (eleventyInstance) => {
console.log("11ty build complete!")
},
serve: (eleventyInstance) => {
console.log("11ty dev server started!")
},
})
}
```
## Options
### `write`
Pass a `write` function to the plugin and it'll run at the start of an Eleventy
build. This function runs for both one-off Eleventy builds and the `--serve` dev
server.
It receives the `eleventyInstance` as an argument.
```javascript
const { shimPlugin } = require("@henrycatalinismith/11tyshim")
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(shimPlugin, {
write: (eleventyInstance) => {
console.log("11ty build starting!")
},
})
}
```
### `finish`
Pass a `finish` function to the plugin and it'll run just before an Eleventy
build finishes. This function only runs in one-off builds of Eleventy sites,
not in the dev server.
It receives the `eleventyInstance` as an argument.
```javascript
const { shimPlugin } = require("@henrycatalinismith/11tyshim")
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(shimPlugin, {
finish: (eleventyInstance) => {
console.log("11ty build complete!")
console.log(`site written to ${eleventyInstance.config.dir.output}`)
},
})
}
```
### `serve`
Pass a `serve` function to the plugin and it'll run just before an Eleventy dev
server starts up. This function only runs in the Eleventy server, never during
one-off builds. Most plugin authors who monkeypatch this method do so to set up
development tools which watch files, rebuild them when they change, and then
reload the Eleventy server.
It receives the `eleventyInstance` as an argument.
```javascript
const { shimPlugin } = require("@henrycatalinismith/11tyshim")
const chokidar = require("chokidar")
const fs = require("fs")
const sass = require("sass")
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(shimPlugin, {
serve: (eleventyInstance) => {
console.log("11ty dev server started!")
chokidar.watch("style.scss").on("all", (event, path) => {
const { css } = sass.renderSync({ file: "style.scss" })
fs.writeFileSync(
`${eleventyInstance.outputDir}/style.css`,
css
)
eleventyInstance.eleventyServe.reload()
})
},
})
}
```
### `verbose`
Pass `verbose: true` to the plugin and it'll output a whole bunch of
information about what it's doing. This is mostly useful for debugging. Please
enable this this option if you're reporting a bug in `11tyshim`.
## Contributing
* [Tips][Contributing]
* [Code of Conduct]
## License
[MIT]
[Contributing]: https://github.com/henrycatalinismith/11tyshim/blob/trunk/contributing.md
[Code of Conduct]: https://github.com/henrycatalinismith/11tyshim/blob/trunk/code_of_conduct.md
[MIT]: https://github.com/henrycatalinismith/11tyshim/blob/trunk/license