Provide a way to specify external license file (#3932)

Create another tslint rule adf-enterprise-license
This commit is contained in:
Maurizio Vitale
2018-10-31 12:59:23 +00:00
committed by Eugenio Romano
parent 3639cc40e7
commit e7ae685bb2
9 changed files with 147 additions and 45 deletions

View File

@@ -2,28 +2,7 @@ import * as path from 'path';
import * as ts from 'typescript';
import * as Lint from 'tslint';
import * as minimatch from 'minimatch';
/** License banner that is placed at the top of every public TypeScript file. */
const licenseBanner = `/*!
* @license
* Copyright 2016 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/`;
/** TSLint fix that can be used to add the license banner easily. */
const tslintFix = Lint.Replacement.appendText(0, licenseBanner + '\n\n');
import * as fs from 'fs';
/**
* Rule that walks through all TypeScript files of public packages and shows failures if a
@@ -56,12 +35,14 @@ class ADFLicenseBannerRule extends Lint.RuleWalker {
/** Whether the walker should check the current source file. */
private _enabled: boolean;
private licensePath: string;
constructor(sourceFile: ts.SourceFile, options: Lint.IOptions) {
super(sourceFile, options);
// Globs that are used to determine which files to lint.
const fileGlobs = options.ruleArguments;
this.licensePath = options.ruleArguments[1];
// Relative path for the current TypeScript source file.
const relativeFilePath = path.relative(process.cwd(), sourceFile.fileName);
@@ -75,8 +56,10 @@ class ADFLicenseBannerRule extends Lint.RuleWalker {
}
const fileContent = sourceFile.getFullText();
const licenseBanner = fs.readFileSync(this.licensePath,'utf8');
const licenseCommentPos = fileContent.indexOf(licenseBanner);
const tslintFix = Lint.Replacement.appendText(0, licenseBanner + '\n\n');
if (licenseCommentPos !== 0) {
return this.addFailureAt(0, 0, Rule.FAILURE_STRING, tslintFix);
}