FilesExpand file tree

 master

/

gulpfile.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

258 lines (229 loc) · 7.78 KB

 master

/

gulpfile.js

Copy path

Top

File metadata and controls

• Code
• Blame

258 lines (229 loc) · 7.78 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

/*---------------------------------------------------------------------------------------------

* Copyright (c) Microsoft Corporation. All rights reserved.

* Licensed under the MIT License. See License.txt in the project root for license information.

*--------------------------------------------------------------------------------------------*/

'use strict';

const gulp = require('gulp');

const filter = require('gulp-filter');

const es = require('event-stream');

const tsfmt = require('typescript-formatter');

const tslint = require('tslint');

const relative = require('relative');

const ts = require('gulp-typescript');

/**

* Hygiene works by creating cascading subsets of all our files and

* passing them through a sequence of checks. Here are the current subsets,

* named according to the checks performed on them. Each subset contains

* the following one, as described in mathematical notation:

*

* all ⊃ eol ⊇ indentation ⊃ copyright ⊃ typescript

*/

const all = [

'src/**/*',

'src/client/**/*',

];

const eolFilter = [

'**',

'!.editorconfig',

'!.eslintrc',

'!.gitignore',

'!.gitmodules',

'!.jshintignore',

'!.jshintrc',

'!.npmrc',

'!.vscodeignore',

'!LICENSE',

'!webpack.config.js',

'!**/node_modules/**',

'!**/*.{svg,exe,png,bmp,scpt,bat,cmd,cur,ttf,woff,eot,txt,md,json,yml}',

'!out/**/*',

'!images/**/*',

'!.vscode/**/*',

'!pythonFiles/**/*',

'!resources/**/*',

'!snippets/**/*',

'!syntaxes/**/*',

'!**/typings/**/*',

];

const indentationFilter = [

'src/**/*.ts',

'!**/typings/**/*',

];

const tslintFilter = [

'src/**/*.ts',

'test/**/*.ts',

'!webpack.config.js',

'!**/node_modules/**',

'!out/**/*',

'!images/**/*',

'!.vscode/**/*',

'!pythonFiles/**/*',

'!resources/**/*',

'!snippets/**/*',

'!syntaxes/**/*',

'!**/typings/**/*',

];

function reportFailures(failures) {

failures.forEach(failure => {

const name = failure.name || failure.fileName;

const position = failure.startPosition;

const line = position.lineAndCharacter ? position.lineAndCharacter.line : position.line;

const character = position.lineAndCharacter ? position.lineAndCharacter.character : position.character;

// Output in format similar to tslint for the linter to pickup.

console.error(`ERROR: (${failure.ruleName}) ${relative(__dirname, name)}[${line + 1}, ${character + 1}]: ${failure.failure}`);

});

}

const hygiene = exports.hygiene = (some, options) => {

options = options || {};

let errorCount = 0;

const eol = es.through(function (file) {

if (/\r\n?/g.test(file.contents.toString('utf8'))) {

console.error(file.relative + ': Bad EOL found');

errorCount++;

}

this.emit('data', file);

});

const indentation = es.through(function (file) {

file.contents

.toString('utf8')

.split(/\r\n|\r|\n/)

.forEach((line, i) => {

if (/^\s*$/.test(line)) {

// Empty or whitespace lines are OK.

} else if (/^(\s\s\s\s)+.*/.test(line)) {

// Good indent.

} else if (/^[\t]+.*/.test(line)) {

console.error(file.relative + '(' + (i + 1) + ',1): Bad whitespace indentation');

errorCount++;

}

});

this.emit('data', file);

});

const formatting = es.map(function (file, cb) {

tsfmt.processString(file.path, file.contents.toString('utf8'), {

verify: true,

tsconfig: true,

tslint: true,

editorconfig: true,

tsfmt: true

}).then(result => {

if (result.error) {

console.error(result.message);

errorCount++;

}

cb(null, file);

}, err => {

cb(err);

});

});

const tsl = es.through(function (file) {

const configuration = tslint.Configuration.findConfiguration(null, '.');

const options = {

formatter: 'json'

};

const contents = file.contents.toString('utf8');

const program = require('tslint').Linter.createProgram("./tsconfig.json");

const linter = new tslint.Linter(options, program);

linter.lint(file.relative, contents, configuration.results);

const result = linter.getResult();

if (result.failureCount > 0 || result.errorCount > 0) {

reportFailures(result.failures);

if (result.failureCount) {

errorCount += result.failureCount;

}

if (result.errorCount) {

errorCount += result.errorCount;

}

}

this.emit('data', file);

});

const tsFiles = [];

const tscFilesTracker = es.through(function (file) {

tsFiles.push(file.path.replace(/\\/g, '/'));

tsFiles.push(file.path);

this.emit('data', file);

});

const tsc = function () {

function customReporter() {

return {

error: function (error) {

const fullFilename = error.fullFilename || '';

const relativeFilename = error.relativeFilename || '';

if (tsFiles.findIndex(file => fullFilename === file || relativeFilename === file) === -1) {

return;

}

errorCount += 1;

console.error(error.message);

},

finish: function () {

// forget the summary.

}

};

}

const tsProject = ts.createProject('tsconfig.json', { strict: true });

const reporter = customReporter();

return tsProject(reporter);

}

const result = gulp.src(some || all, {

base: '.'

})

.pipe(filter(f => !f.stat.isDirectory()))

.pipe(filter(eolFilter))

.pipe(options.skipEOL ? es.through() : eol)

.pipe(filter(indentationFilter))

.pipe(indentation);

const typescript = result

.pipe(filter(tslintFilter))

.pipe(formatting)

.pipe(tsl)

.pipe(tscFilesTracker)

.pipe(tsc());

return typescript

.pipe(es.through(null, function () {

if (errorCount > 0) {

this.emit('error', 'Hygiene failed with ' + errorCount + ' errors. Check \'gulpfile.js\'.');

} else {

this.emit('end');

}

}));

};

gulp.task('hygiene', () => hygiene());

// this allows us to run hygiene as a git pre-commit hook.

if (require.main === module) {

const cp = require('child_process');

process.on('unhandledRejection', (reason, p) => {

console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);

process.exit(1);

});

cp.exec('git config core.autocrlf', (err, out) => {

const skipEOL = out.trim() === 'true';

if (process.argv.length > 2) {

return hygiene(process.argv.slice(2), {

skipEOL: skipEOL

}).on('error', err => {

console.error();

console.error(err);

process.exit(1);

});

}

cp.exec('git diff --cached --name-only', {

maxBuffer: 2000 * 1024

}, (err, out) => {

if (err) {

console.error();

console.error(err);

process.exit(1);

}

const some = out

.split(/\r?\n/)

.filter(l => !!l);

hygiene(some, {

skipEOL: skipEOL

}).on('error', err => {

console.error();

console.error(err);

process.exit(1);

});

});

});

}