gulp-jscad-files

gulp-jscad-files

This gulp plugin reads jscad.json library files, and their NPM dependencies.

Example

To find jscad.json files and place those and their NPM files into a directory called dist:

gulp.task("lib", function() {
  return gulp
    .src("node_modules/**/jscad.json")
    .pipe(plugins.plumber())
    .pipe(plugins.jscadFiles())
    .pipe(plugins.flatten())
    .pipe(gulp.dest("dist"));
});

Watching injected files

To watch only the files that are injected, reducing the total number of files watched, you can use the getImported function.

var { getInjected } = require("gulp-jscad-files/getPackage");

gulp.task(
  "default",
  gulp.series(["clean", "inject"], function() {
    gulp.watch(
      ["**/*.jscad", ...getInjected(pkg)],
      {
        followSymlinks: true,
        delay: 500,
        queue: false,
        ignoreInitial: false,
        ignored: ["**/*.*~", "dist/*", ".vuepress/*", "public", "node_modules"]
      },
      gulp.series(["inject"])
    );
  })
);

jscad Modules

You can create a jscad module by creating a NPM module with your jscad files and a jscad.json file that contains a files array.

{
  "files": ["jscad-utils.jscad"]
}

gulp-jscad-files will read the jscad.json project file and the package.json file in that directory to determine the required files for that module. You can use a gulp task to place those files into a directory being monitored by a openjscad.org page.