sp-js-provisioning 1.0.4 → 1.1.2

package/gulptasks/@configuration.js

@@ -1,58 +0,0 @@
-// defines the configuration used by the gulp tasks
-
-function getBanner() {
-
-    let pkg = require("../package.json");
-
-    return [    
-        "/**",
-        ` * ${pkg.name} v${pkg.version} - ${pkg.description}`,
-        ` * ${pkg.license} (https://github.com/SharePoint/PnP-JS-Provisioning/blob/master/LICENSE)`,
-        " * Copyright (c) 2016 Microsoft",
-        " * docs: http://officedev.github.io/PnP-JS-Core",
-        ` * source: ${pkg.homepage}`,
-        ` * bugs: ${pkg.bugs.url}`,
-    ].join("\n");
-}
-
-function getSettings() {
-
-    try {
-         return require("../settings.js");
-    } catch(e) {
-         return require("../settings.example.js");
-    }
-}
-
-// simplified exports of the config
-module.exports = {
-    paths: {
-        dist: "./dist",
-        lib: "./lib",
-        source: "./src",
-        sourceGlob: "./src/**/*.ts",
-    },
-    testing: {
-        testsSource: "./tests",
-        testsSourceGlob: "./tests/**/*.ts",
-        testingRoot: "./testing",
-        testingTestsDest: "./testing/tests",
-        testingTestsDestGlob: "./testing/tests/**/*.js",
-        testingSrcDest: "./testing/src",
-        testingSrcDestGlob: "./testing/src/**/*.js"
-    },
-    debug: {
-        debugSourceGlob: "./debug/**/*.ts",
-        outputRoot: "./debugging",
-        outputSrc: "./debugging/src",
-        outputDebug: "./debugging/debug",
-        schemasSourceGlob: "./sample-schemas/**/*.ts",
-        schemasOutput: "./debugging/sample-schemas"
-    },
-    docs: {
-        include: "./lib/**/*.js",
-        output: "./docs"
-    },
-    header: getBanner(),
-    settings: getSettings()
-}

package/gulptasks/build.js

@@ -1,84 +0,0 @@
-//******************************************************************************
-//* build.js
-//* 
-//* Defines a custom gulp task for compiling TypeScript source code into
-//* js files.  It outputs the details as to what it generated to the console.
-//******************************************************************************
-
-var gulp = require("gulp"),
-    tsc = require("gulp-typescript"),
-    config = require('./@configuration.js'),
-    merge = require("merge2"),
-    sourcemaps = require('gulp-sourcemaps'),
-    pkg = require("../package.json");
-
-gulp.task("build:lib", () => {
-
-    var project = tsc.createProject("tsconfig.json", { declaration: true });
-
-    var built = gulp.src(config.paths.sourceGlob)
-        .pipe(project());
-
-    return merge([
-        built.dts.pipe(gulp.dest(config.paths.lib)),
-        built.js.pipe(gulp.dest(config.paths.lib))
-    ]);
-});
-
-gulp.task("build:testing", ["clean"], () => {
-    var projectSrc = tsc.createProject("tsconfig.json");
-    var projectTests = tsc.createProject("tsconfig.json");
-
-    return merge([
-        gulp.src(config.testing.testsSourceGlob)
-            .pipe(projectTests({
-                compilerOptions: {
-                    types: [
-                        "chai",
-                        "chai-as-promised",
-                        "node",
-                        "mocha"
-                    ]
-                }
-            }))
-            .pipe(gulp.dest(config.testing.testingTestsDest)),
-        gulp.src(config.paths.sourceGlob)
-            .pipe(projectSrc())
-            .pipe(gulp.dest(config.testing.testingSrcDest))
-    ]);
-});
-
-gulp.task("build:debug", ["clean"], () => {
-
-    var srcProject = tsc.createProject("tsconfig.json");
-    var debugProject = tsc.createProject("tsconfig.json");
-    var schemaProject = tsc.createProject("tsconfig.json");
-
-    let sourceMapSettings = {
-        includeContent: false,
-        sourceRoot: (file) => {
-            return "..\\.." + file.base.replace(file.cwd, "");
-        }
-    };
-
-    return merge([
-        gulp.src(config.paths.sourceGlob)
-            .pipe(sourcemaps.init())
-            .pipe(srcProject())
-            .pipe(sourcemaps.write(".", sourceMapSettings))
-            .pipe(gulp.dest(config.debug.outputSrc)),
-        gulp.src(config.debug.debugSourceGlob)
-            .pipe(sourcemaps.init())
-            .pipe(debugProject())
-            .pipe(sourcemaps.write(".", sourceMapSettings))
-            .pipe(gulp.dest(config.debug.outputDebug)),
-        gulp.src(config.debug.schemasSourceGlob)
-            .pipe(sourcemaps.init())
-            .pipe(schemaProject())
-            .pipe(sourcemaps.write(".", sourceMapSettings))
-            .pipe(gulp.dest(config.debug.schemasOutput))
-    ]);
-});
-
-// run the build chain for lib
-gulp.task("build", ["clean", "lint", "build:lib"]);

package/gulptasks/clean.js

@@ -1,23 +0,0 @@
-//******************************************************************************
-//* clean.js
-//*
-//* Defines a custom gulp task for removing all output files that were 
-//* autogenerated by other custom gulp tasks 
-//******************************************************************************
-
-var gulp = require("gulp"),
-    del = require('del'),
-    config = require('./@configuration.js');
-
-gulp.task('clean', (done) => {
-
-    var directories = [
-        config.paths.dist,
-        config.paths.lib,
-        config.testing.testingRoot,
-        config.debug.outputRoot,
-        config.docs.output
-    ];
-    
-    del(directories).then(() => done());
-});

package/gulptasks/docs.js

@@ -1,11 +0,0 @@
-var gulp = require("gulp"),
-    jsdoc = require('gulp-jsdoc3'),
-    del = require('del'),
-    jsdocConfig = require('../jsdoc.json'),
-    config = require('./@configuration.js');
-
-gulp.task("docs", ["clean", "build:lib"], (done) => {
-    
-    gulp.src(['./README.md', config.docs.include], { read: false })
-        .pipe(jsdoc(jsdocConfig, done));
-});

package/gulptasks/index.js

@@ -1,8 +0,0 @@
-require("./clean.js");
-require("./lint.js");
-require("./build.js");
-require("./package.js");
-require("./test.js");
-require("./docs.js");
-require("./publish.js");
-require("./watch.js");

package/gulptasks/lint.js

@@ -1,18 +0,0 @@
-//******************************************************************************
-//* lint.js
-//*
-//* Defines a custom gulp task for ensuring that all source code in
-//* this repository follows recommended TypeScript practices. 
-//*
-//* Rule violations are output automatically to the console.
-//******************************************************************************
-
-var gulp = require("gulp"),
-    tslint = require("gulp-tslint"),
-    config = require('./@configuration.js');
-
-gulp.task("lint", function () {
-    return gulp.src(config.paths.sourceGlob)
-        .pipe(tslint({ formatter: "prose" }))
-        .pipe(tslint.report({ emitError: false }));
-});

package/gulptasks/package.js

@@ -1,44 +0,0 @@
-//******************************************************************************
-//* package.js
-//* 
-//* Defines a custom gulp task for creaing pnp.js, pnp.min.js, 
-//* and pnp.min.js.map in the dist folder
-//******************************************************************************
-var gulp = require("gulp"),
-    tsc = require("gulp-typescript"),
-    webpack = require('webpack'),
-    webpackConfig = require('../webpack.config.js'),
-    config = require('./@configuration.js'),
-    gutil = require('gulp-util');
-
-// package the definitions
-gulp.task("package:defs", () => {
-
-    var typingsProject = tsc.createProject('tsconfig.json', { "declaration": true, "outFile": "pnp.js", "removeComments": false, "module": "system" });
-
-    gulp.src(config.paths.sourceGlob).pipe(typingsProject()).dts.pipe(gulp.dest(config.paths.dist));
-    
-});
-
-// package the code files using webpack
-gulp.task("package:code", ["build:lib"], (done) => {
-
-    webpack(webpackConfig, (err, stats) => {
-
-        if (err) {
-            throw new gutil.PluginError("package:code", err);
-        }
-            
-        console.log(stats.toString({
-            colors: true
-        }));
-
-        done();
-    });
-});
-
-// used by the sync task to rebuild code
-gulp.task("package:sync", ["package:code"]);
-
-// run the package chain
-gulp.task("package", ["clean", "lint", "package:code", "package:defs"]);

package/gulptasks/publish.js

@@ -1,232 +0,0 @@
-//******************************************************************************
-//* publish.js
-//*
-//* Defines a custom gulp task for publishing this repository to npm in 
-//* both main and beta versions for different branches
-//*
-//******************************************************************************
-
-const
-    gulp = require("gulp"),
-    tslint = require("gulp-tslint"),
-    config = require('./@configuration.js'),
-    semver = require('semver'),
-    fs = require('fs'),
-    package = require("../package.json"),
-    execSync = require('child_process').execSync,
-    readline = require('readline');
-
-const log = (value) => { console.log(value); return value };
-const exec = (command) => execSync(log(command), { encoding: 'utf8' });
-
-function publishSetup() {
-
-    log(`Starting automated npm publish of ${package.name}...`);
-}
-
-function publishBetaSetup() {
-
-    log(`Starting automated npm publish of BETA for ${package.name}...`);
-}
-
-function mergeDevToMaster() {
-
-    log('## Merge dev -> master');
-    exec('git checkout dev');
-    exec('git pull');
-    exec('git checkout master');
-    exec('git pull');
-    exec('git merge dev');
-    log(exec('npm install'));
-}
-
-function incrementPackage() {
-
-    log('## Incrementing the package version');
-    const npmVersion = semver.clean(exec(`npm show ${package.name} version`));
-    const newVersion = exec('npm version patch');
-
-    log(`Current version in package.json: ${package.version}`);
-    log(`Latest version on npm: ${npmVersion}`);
-    log(`New version after patch: ${newVersion}`);
-
-    if (!semver.gt(newVersion, npmVersion)) {
-        log('Aborting publish, local version is not new.');
-        process.exit(0);
-    }
-    log('## Incremented the package version');
-}
-
-function updateDistFiles() {
-
-    log('## Updating dist files');
-    exec('git checkout master');
-    log('Updating .gitignore to allow dist/ upload');
-    var data = fs.readFileSync('./.gitignore', 'utf-8');
-    var newValue = data.replace(/^dist\/$/gim, '#dist/');
-    fs.writeFileSync('.gitignore', newValue, 'utf-8');
-    log('Updated .gitignore to allow dist/ upload');
-    log(exec('git status'));
-    exec('gulp package');
-    log('## Updated dist files');
-}
-
-function commitDistFiles() {
-
-    log('## Committing Dist Files');
-    exec('git add dist/');
-    exec('git commit -m "update to dist during master merge"');
-    exec('git checkout .gitignore');
-    exec('git push');
-    log('## Committed Dist Files');
-}
-
-function publishToNPMGate() {
-
-    log('##');
-    log('## -->> The next step will publish the package to NPM!!! <<--');
-    log('##');
-}
-
-function publishToNPM() {
-    log('## Publishing to NPM');
-    log(exec('npm publish'));
-    log('## Published to NPM');
-}
-
-function mergeMasterToDev() {
-
-    log('## Merging master -> dev');
-    exec('git checkout master');
-    exec('git pull');
-    exec('git checkout dev');
-    exec('git pull');
-    exec('git merge master');
-    exec('rmdir /S /Q dist');
-    exec('git add .');
-    exec('git commit -m "clean-up dist for dev branch"');
-    exec('git push');
-    log('## Merged master -> dev');
-}
-
-function updateDevForBeta() {
-
-    log('## Updating dev branch for beta release.');
-
-    exec('git checkout dev');
-    exec('git pull');
-    exec('npm install');
-
-    const npmVersion = semver.clean(exec(`npm show ${package.name} version`));
-    const newVersion = semver.inc(package.version, 'prerelease', 'beta');
-
-    log(`Current version in package.json: ${package.version}`);
-    log(`Latest version on npm: ${npmVersion}`);
-    log(`New version after patch: ${newVersion}`);
-
-    exec(`npm version ${newVersion}`);
-
-    if (!semver.gt(newVersion, npmVersion)) {
-        log('Aborting publish, local version is not new.');
-        process.exit(0);
-    }
-
-    log('## Updated dev branch for beta release.');
-}
-
-function betaPushVersionUpdate() {
-
-    log('## Pushing dev branch for beta release.');
-    exec('git push');
-    log('## Pushed dev branch for beta release.');
-}
-
-function betaPackage() {
-
-    log('## Packaging files for BETA release');
-    exec('git checkout dev');
-    exec('gulp package');
-    log('## Packaged files for BETA release');
-}
-
-function betaPublishToNPM() {
-
-    log('## Publishing to NPM');
-    log(exec('npm publish --tag beta'));
-    log('## Published to NPM');
-}
-
-function engine(tasks, rl) {
-
-    let task = tasks.shift();
-
-    task();
-
-    if (tasks.length > 1) {
-
-        rl.question('Do you want to continue? (/^y(es)?$/i): ', (answer) => {
-            if (answer.match(/^y(es)?$/i)) {
-                rl.pause();
-                engine(tasks, rl);
-            } else {
-
-                // run the final cleanup and shutdown task.
-                tasks.pop()();
-            }
-        });
-    } else if (tasks.length === 1) {
-
-        // run the final cleanup and shutdown task.
-        tasks.pop()();
-    }
-}
-
-gulp.task("publish", (done) => {
-
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout
-    });
-
-    const publishTasks = [
-        publishSetup,
-        mergeDevToMaster,
-        incrementPackage,
-        updateDistFiles,
-        commitDistFiles,
-        publishToNPMGate,
-        publishToNPM,
-        mergeMasterToDev,
-        function () {
-            log('Publishing complete');
-            rl.close();
-            done();
-        },
-    ];
-
-    engine(publishTasks, rl);
-});
-
-gulp.task("publish-beta", (done) => {
-
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout
-    });
-
-    const publishBetaTasks = [
-        publishBetaSetup,
-        updateDevForBeta,
-        betaPushVersionUpdate,
-        betaPackage,
-        publishToNPMGate,
-        betaPublishToNPM,
-        function () {
-            log('BETA Publishing complete');
-            rl.close();
-            done();
-        },
-    ];
-
-    engine(publishBetaTasks, rl);
-});

package/gulptasks/test.js

@@ -1,40 +0,0 @@
-//******************************************************************************
-//* test.js
-//*
-//* Defines a custom gulp task for executing the unit tests (with mocha) and
-//* also reporting on code coverage (with istanbul).
-//******************************************************************************
-
-var gulp = require("gulp"),
-    mocha = require("gulp-mocha"),
-    istanbul = require("gulp-istanbul"),
-    tsc = require("gulp-typescript"),
-    yargs = require('yargs').argv,
-    config = require('./@configuration.js'),
-    istanbul = require("gulp-istanbul");
-
-
-gulp.task("_istanbul:hook", ["build:testing"], () => {
-
-    return gulp.src(config.testing.testingSrcDestGlob)
-        .pipe(istanbul())
-        .pipe(istanbul.hookRequire());
-});
-
-gulp.task("test", ["_istanbul:hook"], () => {
-
-    // when using single, grab only that test.js file - otherwise use the entire test.js glob
-    let path = yargs.single ? './testing/tests/{path}.test.js'.replace('{path}', yargs.single) : config.testing.testingTestsDestGlob;
-
-    // determine if we show the full coverage table
-    let reports = yargs["coverage-details"] ? ['text', 'text-summary'] : ['text-summary'];
-
-    // easiest way for tests to have settings available
-    global.settings = config.settings;
-
-        return gulp.src(path)
-        .pipe(mocha({ ui: 'bdd', reporter: 'dot', timeout: 10000 }))
-        .pipe(istanbul.writeReports({
-            reporters: reports
-        }));
-});

package/gulptasks/watch.js

@@ -1,15 +0,0 @@
-//******************************************************************************
-//* watch.js
-//* 
-//******************************************************************************
-
-var gulp = require("gulp"),
-    gulpWatch = require("gulp-watch"),
-    runSequence = require("run-sequence"),
-    config = require('./@configuration.js');
-
-gulp.task("watch", () => {
-    gulpWatch(config.paths.sourceGlob).on("change", () => {
-        runSequence("build");
-    });
-});

package/jsdoc.json

@@ -1,26 +0,0 @@
-{
-    "tags": {
-        "allowUnknownTags": true,
-        "dictionaries": [
-            "jsdoc",
-            "closure"
-        ]
-    },
-    "source": {
-        "include": [
-            "./lib"
-        ],
-        "includePattern": "\\.js$"
-    },
-    "plugins": [],
-    "templates": {
-        "cleverLinks": false,
-        "monospaceLinks": false
-    },
-    "opts": {
-        "template": "templates/default",
-        "encoding": "utf8",
-        "destination": "./docs/",
-        "recurse": true
-    }
-}