Registry / devops / gulp-purescript

gulp-purescript

library2.0.1jsnpmunverified

The gulp-purescript package (v2.0.1) is a Gulp plugin that wraps the PureScript compiler (purs) to automate compilation, bundling, and documentation generation tasks. It requires the PureScript binaries to be installed separately (e.g., via the 'purescript' npm package). The plugin's API mirrors PureScript commands: compile, bundle, and docs. Breaking changes in v2.0.0 renamed psc to compile, pscBundle to bundle, and pscDocs to docs, aligning with PureScript 0.11. The package is maintained by the PureScript community under purescript-contrib. It is a legacy tool suited for projects using older Gulp workflows; alternatives include direct use of purs or Spago.

devops

npm install gulp-purescript

github ↗package ↗

INSTALL

IMPORT

SIG · GULP-PURESCRIPT

gulp-purescript

devopsjavascriptv2.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import purescript from 'gulp-purescript'

✗ const purescript = require('gulp-purescript')

ESM import works in modern setups; CJS require() also works.

compile

✓ import { compile } from 'gulp-purescript'

✗ import { psc } from 'gulp-purescript'

Renamed from psc to compile in v2.0.0.

bundle

✓ import { bundle } from 'gulp-purescript'

✗ import { pscBundle } from 'gulp-purescript'

Renamed from pscBundle to bundle in v2.0.0.

docs

✓ import { docs } from 'gulp-purescript'

✗ import { pscDocs } from 'gulp-purescript'

Renamed from pscDocs to docs in v2.0.0.

Demonstrates compile, bundle, and docs tasks with common options.

import gulp from 'gulp'; import { compile, bundle, docs } from 'gulp-purescript'; const purescript = require('gulp-purescript'); gulp.task('compile', function() { return purescript.compile({ src: ['src/**/*.purs'], output: 'output', comments: false }); }); gulp.task('bundle', function() { return purescript.bundle({ src: 'output/**/*.js', output: 'dist/bundle.js', module: 'Main', main: true }); }); gulp.task('docs', function() { return purescript.docs({ src: 'src/**/*.purs', format: 'markdown' }); });

Debug

Known issues

breakingpsc, pscBundle, pscDocs functions renamed to compile, bundle, docs

fix

Update your gulp tasks to use the new names: compile, bundle, docs

affects: 2.0.0

breakingOptions updated to match PureScript 0.11

fix

Review and update options passed to each function, consult PureScript 0.11 compiler docs

affects: 2.0.0

gotchaRequires PureScript binaries installed separately

fix

Install the 'purescript' npm package or binaries via purescript.org

affects: >=0

deprecatedGulp v4+ compatibility may require using async tasks or returning streams

fix

Return a stream or use async/await in your gulp task

affects: >=1.0.0

gotchaRTS flags passed via --purs-rts-flags argument to gulp

fix

Use gulp --purs-rts-flags +RTS -N -RTS for runtime options

affects: >=0.8.0

Errors

Common errors & fixes

Error: Cannot find module 'gulp-purescript'

Package not installed or misspelled

fix

Run npm install --save-dev gulp-purescript

TypeError: purescript.psc is not a function

Function renamed from psc to compile in v2.0.0

fix

Use purescript.compile() instead of purescript.psc()

purs: command not found

PureScript binaries not installed

fix

Install purescript npm package globally or locally: npm install purescript

TypeError: Cannot read property 'apply' of undefined (gulp task)

Gulp v4 expects a function that returns a stream or promise

fix

Ensure your gulp task returns the stream: return purescript.compile(...)

Upgrade

Version history

2.0.1latest on npm

Audit

Dependencies

gulprequiredPeer dependency for gulp plugin compatibility

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/purescript-contrib/gulp-purescript ↗

packagehttps://www.npmjs.com/package/gulp-purescript ↗