This is a base package for building and publishing javascript and/or typescript applications using gulp, creating a set of convenient packaging functionality for typescript and javascript projects.
The package gulp-base can be used to build and publish CommonJS packages, ECMAScript packages, or both into one distribution package. CommonJS is still heavily leveraged and may continue to be owing to its prevalence and synchronous module loading capabilities. There is no telling how long this module loading standard will be around, however leveraging gul-base you don't need to worry about it.
npm i gulp-base --save-devUse these instructions as a guide for creating or converting an existing repo to gulp-base. The instructions are written for a new repo, however can easily be followed to understand how to convert an existing repo.
-
Nodejs Ensure the latest stable node release is installed. Versions earlier than 16.x.x have not been tested, but let us know if they work or what issues you encounter!
-
NPM Ensure you have NPM >= 5.2 installed so that npx is supported. If not, you will have to use alternative commands.
-
Install gulp-cli globally per gulp.js. Needs to be >= 4.0
-
If desired, per typescript instructions, install typescript globally
-
Installing this package will install typescript locally. If you want to run tsc globally, install typescript globally. If you have it installed globally, compare typescript versions to better understand issues, if they occur.
-
Per gulp.js instructions, install gulp-cli globally.
npx gbscaffold
npm i gulp-base --save-dev
The scaffolding consists of directories, base packages and files. Some defaults are requested as part of running gbscaffold, while others are assumed. All defaults can be overriden in the final scaffolding. The scaffolding created is described below in Scaffolding
- [project]