@voitanos/eslint-preset-spfx-react/scripts/postinstall.js

Preset to swap out TSLint in favor of ESLint in SharePoint Framework (non-React) projects.

#!/usr/bin/env node
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
// bail on postinstall if this is a build
if (process.env.IS_BUILD) {
    console.log('skipping POSTINSTALL script');
    process.exit(0);
}
var fs = require("fs");
var path = require("path");
var CURR_DIR = path.resolve(__dirname);
// split directory path (non-windows)
var nestedDirs = CURR_DIR.split("/");
// split directory path (windows)
if (nestedDirs.length <= 1) {
    nestedDirs = CURR_DIR.split("\\");
}
// verify path
if (nestedDirs.length === 0) {
    console.error('ERROR: unexpected install path.');
}
// find the node_modules folder
var nmIndex = nestedDirs.indexOf('node_modules');
// verify node_modules found & get the path to one level up...
//  this should be the project root
if (nmIndex === -1) {
    console.error('ERROR: expected folder \'node_modules\' not found.');
}
var nest = nestedDirs.slice(nmIndex);
if (!nest || nest.length === 0) {
    console.error('ERROR: unexpected install path.');
}
var paths = nest.map(function (m) { return ".."; });
var projectPath = path.resolve(path.join(__dirname, paths.join('/')));
/**
 *
 * STEP 1: ESLINT CONFIG FILE
 *
 */
console.log('');
console.log('ESLINT PRESET POSTINSTALL STEP 1 of 4...');
var CONFIG_FILENAME = 'eslint.json';
console.log("INFO: Adding ESLint configuration file to: ./config/" + CONFIG_FILENAME);
var configFilePath = path.resolve(path.join(projectPath, 'config', CONFIG_FILENAME));
// check if config file present
if (fs.existsSync(configFilePath)) {
    console.log("      .. " + CONFIG_FILENAME + " exists! No changes required.");
}
else {
    // doesn't exist, so copy it in
    console.log("INFO: " + CONFIG_FILENAME + " not found; creating it");
    // get path to sample file
    var configTemplate = path.join(CURR_DIR, '..', 'resources', "" + CONFIG_FILENAME);
    // copy file in
    fs.copyFileSync(configTemplate, configFilePath);
}
var SPFX_RULES_FILENAME = 'eslint.spfx.json';
console.log('');
console.log("INFO: Adding ESLint SPFx rules file to: ./config/" + SPFX_RULES_FILENAME);
var spfxRulesPath = path.resolve(path.join(projectPath, 'config', SPFX_RULES_FILENAME));
// check if config file present
if (fs.existsSync(spfxRulesPath)) {
    console.log("      .. " + SPFX_RULES_FILENAME + " exists! No changes required.");
}
else {
    // doesn't exist, so copy it in
    console.log("INFO: " + SPFX_RULES_FILENAME + " not found; creating it");
    // get path to sample file
    var configTemplate = path.join(CURR_DIR, '..', 'resources', "" + SPFX_RULES_FILENAME);
    // copy file in
    fs.copyFileSync(configTemplate, spfxRulesPath);
}
/**
 *
 * STEP 2: ESLINT IGNORE FILE
 *
 */
console.log('');
console.log('ESLINT PRESET POSTINSTALL STEP 2 of 4...');
var IGNORE_FILENAME = '.eslintignore';
console.log("INFO: Adding ESLint ignore file to: ./" + IGNORE_FILENAME);
var ignoreFilePath = path.resolve(path.join(projectPath, IGNORE_FILENAME));
// check if file present
if (fs.existsSync(ignoreFilePath)) {
    console.log("      .. " + IGNORE_FILENAME + " exists! No changes required.");
}
else {
    // doesn't exist, so copy it in
    console.log("INFO: " + IGNORE_FILENAME + " not found; creating it");
    // get path to sample file
    var configTemplate = path.join(CURR_DIR, '..', 'resources', IGNORE_FILENAME);
    // copy file in
    fs.copyFileSync(configTemplate, ignoreFilePath);
}
/**
 *
 * STEP 3: UPDATE GULPFILE.JS WITH ESLINT TASK
 *
 */
console.log('');
console.log('ESLINT PRESET POSTINSTALL STEP 3 of 4...');
console.log("INFO: Updating gulpfile.js add eslint task");
var GULPFILE_FILEPATH = path.resolve(path.join(projectPath, 'gulpfile.js'));
var gulpFileData = fs.readFileSync(GULPFILE_FILEPATH, 'utf8');
// read in all data from the template file
var GULPDELTA_FILEPATH = path.join(CURR_DIR, '..', 'resources', 'gulpfile.delta.js');
var GULPDELTA_CONTENT = fs.readFileSync(GULPDELTA_FILEPATH, 'utf8');
// update file contents
fs.writeFileSync(GULPFILE_FILEPATH, gulpFileData.replace(/build.initialize\(require\('gulp'\)\);/g, GULPDELTA_CONTENT));
/**
 *
 * STEP 4: DELETE TSLINT.JSON
 * > only if present
 *
*/
console.log('');
console.log('ESLINT PRESET POSTINSTALL STEP 4 of 4...');
console.log("INFO: Deleting tslint.info unnecessary file");
var TSLINT_FILEPATH = path.resolve(path.join(projectPath, 'tslint.json'));
// delete file (if present)
if (fs.existsSync(TSLINT_FILEPATH)) {
    fs.unlinkSync(TSLINT_FILEPATH);
}