inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[AAE-10461] Fix license header checker (#7823)

Browse Source 
* [AAE-10461] Fix license header checker

* trigger travis

* fix license headers for cli lib

* rebase
This commit is contained in:
Tomasz Gnyp
2022-09-12 19:07:27 +02:00
committed by GitHub
parent 88beaf3535
commit b7e8abc529
74 changed files with 589 additions and 286 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
tools/tslint-rules/adfEnterpriseLicenseBannerRule.js
View File

@@ -1,46 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const path = require("path");
const Lint = require("tslint");
const minimatch = require("minimatch");
const fs = require("fs");
class Rule extends Lint.Rules.AbstractRule {
apply(sourceFile) {
return this.applyWithWalker(new ADFEnterpriseLicenseBannerRule(sourceFile, this.getOptions()));
}
}
Rule.metadata = {
ruleName: 'adf-enterprise-license-banner',
type: 'maintainability',
description: ``,
descriptionDetails: ``,
rationale: ``,
options: null,
optionsDescription: `Not configurable.`,
typescriptOnly: true,
};
Rule.FAILURE_STRING = 'Missing license header in this TypeScript ' +
'file Every TypeScript file of the library needs to have the Alfresco license banner at the top.';
exports.Rule = Rule;
class ADFEnterpriseLicenseBannerRule extends Lint.RuleWalker {
constructor(sourceFile, options) {
super(sourceFile, options);
const fileGlobs = options.ruleArguments;
this.licensePath = options.ruleArguments[1];
const relativeFilePath = path.relative(process.cwd(), sourceFile.fileName);
this._enabled = fileGlobs.some(p => minimatch(relativeFilePath, p));
}
visitSourceFile(sourceFile) {
if (!this._enabled) {
return;
}
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);
}
super.visitSourceFile(sourceFile);
}
}

69
tools/tslint-rules/adfEnterpriseLicenseBannerRule.ts
View File

@@ -1,69 +0,0 @@
import * as path from 'path';
import * as ts from 'typescript';
import * as Lint from 'tslint';
import * as minimatch from 'minimatch';
import * as fs from 'fs';
/**
* Rule that walks through all TypeScript files of public packages and shows failures if a
* file does not have the license banner at the top of the file.
*/
export class Rule extends Lint.Rules.AbstractRule {
public static metadata: Lint.IRuleMetadata = {
ruleName: 'adf-enterprise-license-banner',
type: 'maintainability',
description: ``,
descriptionDetails: ``,
rationale: ``,
options: null,
optionsDescription: `Not configurable.`,
typescriptOnly: true,
};
static FAILURE_STRING: string = 'Missing license header in this TypeScript ' +
'file Every TypeScript file of the library needs to have the Alfresco license banner at the top.';
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithWalker(
new ADFEnterpriseLicenseBannerRule(sourceFile,
this.getOptions()));
}
}
class ADFEnterpriseLicenseBannerRule 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);
// Whether the file should be checked at all.
this._enabled = fileGlobs.some(p => minimatch(relativeFilePath, p));
}
visitSourceFile(sourceFile: ts.SourceFile) {
if (!this._enabled) {
return;
}
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);
}
super.visitSourceFile(sourceFile);
}
}

46
tools/tslint-rules/adfLicenseBannerRule.js
View File

@@ -1,46 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const path = require("path");
const Lint = require("tslint");
const minimatch = require("minimatch");
const fs = require("fs");
class Rule extends Lint.Rules.AbstractRule {
apply(sourceFile) {
return this.applyWithWalker(new ADFLicenseBannerRule(sourceFile, this.getOptions()));
}
}
Rule.metadata = {
ruleName: 'adf-license-banner',
type: 'maintainability',
description: ``,
descriptionDetails: ``,
rationale: ``,
options: null,
optionsDescription: `Not configurable.`,
typescriptOnly: true,
};
Rule.FAILURE_STRING = 'Missing license header in this TypeScript ' +
'file Every TypeScript file of the library needs to have the Alfresco license banner at the top.';
exports.Rule = Rule;
class ADFLicenseBannerRule extends Lint.RuleWalker {
constructor(sourceFile, options) {
super(sourceFile, options);
const fileGlobs = options.ruleArguments;
this.licensePath = options.ruleArguments[1];
const relativeFilePath = path.relative(process.cwd(), sourceFile.fileName);
this._enabled = fileGlobs.some(p => minimatch(relativeFilePath, p));
}
visitSourceFile(sourceFile) {
if (!this._enabled) {
return;
}
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);
}
super.visitSourceFile(sourceFile);
}
}

69
tools/tslint-rules/adfLicenseBannerRule.ts
View File

@@ -1,69 +0,0 @@
import * as path from 'path';
import * as ts from 'typescript';
import * as Lint from 'tslint';
import * as minimatch from 'minimatch';
import * as fs from 'fs';
/**
* Rule that walks through all TypeScript files of public packages and shows failures if a
* file does not have the license banner at the top of the file.
*/
export class Rule extends Lint.Rules.AbstractRule {
public static metadata: Lint.IRuleMetadata = {
ruleName: 'adf-license-banner',
type: 'maintainability',
description: ``,
descriptionDetails: ``,
rationale: ``,
options: null,
optionsDescription: `Not configurable.`,
typescriptOnly: true,
};
static FAILURE_STRING: string = 'Missing license header in this TypeScript ' +
'file Every TypeScript file of the library needs to have the Alfresco license banner at the top.';
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
return this.applyWithWalker(
new ADFLicenseBannerRule(sourceFile,
this.getOptions()));
}
}
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);
// Whether the file should be checked at all.
this._enabled = fileGlobs.some(p => minimatch(relativeFilePath, p));
}
visitSourceFile(sourceFile: ts.SourceFile) {
if (!this._enabled) {
return;
}
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);
}
super.visitSourceFile(sourceFile);
}
}

2
tools/tslint-rules/index.js
View File

@@ -6,6 +6,4 @@ var adfFileNameRule_1 = require("./adfFileNameRule");
exports.ADFComponentSelectorRule = adfFileNameRule_1.Rule;
var adfPrefixNameRule_1 = require("./adfPrefixNameRule");
exports.ADFOutputPrefixNameRule = adfPrefixNameRule_1.Rule;
var adfLicenseBannerRule_1 = require("./adfLicenseBannerRule");
exports.ADFLicenseBannerRule = adfLicenseBannerRule_1.Rule;
exports.rulesDirectory = '.';

1
tools/tslint-rules/index.ts
View File

@@ -1,6 +1,5 @@
export { Rule as ADFClassNameRule } from './adfClassNameRule';
export { Rule as ADFComponentSelectorRule } from './adfFileNameRule';
export { Rule as ADFOutputPrefixNameRule } from './adfPrefixNameRule';
export { Rule as ADFLicenseBannerRule } from './adfLicenseBannerRule';
export const rulesDirectory = '.';