@atomist/sdm-pack-spring
Version:
Atomist software delivery machine extension pack for Spring and Spring Boot applications
74 lines • 3.76 kB
JavaScript
;
/*
* Copyright © 2018 Atomist, Inc.
*
* 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.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const antlr_1 = require("@atomist/antlr");
const automation_client_1 = require("@atomist/automation-client");
const FileHits_1 = require("@atomist/automation-client/lib/tree/ast/FileHits");
const javaProjectUtils_1 = require("../../java/javaProjectUtils");
const springReviewCategories_1 = require("../review/springReviewCategories");
/**
* An @ComponentScan annotation isn't necessary on a @SpringBootApplication class.
* Remove it.
* @type {string}
*/
const UnnecessaryComponentScanAnnotations = `//typeDeclaration[/classDeclaration]
[//annotation[@value='@SpringBootApplication']]
//annotation[@value='@ComponentScan']`;
exports.removeUnnecessaryComponentScanTransform = p => {
return automation_client_1.astUtils.zapAllMatches(p, antlr_1.Java9FileParser, javaProjectUtils_1.JavaSourceFiles, UnnecessaryComponentScanAnnotations, FileHits_1.ZapTrailingWhitespace);
};
exports.UnnecessaryComponentScanCategory = "unnecessary annotations";
exports.unnecessaryComponentScanReviewer = (p) => __awaiter(void 0, void 0, void 0, function* () {
const matches = yield automation_client_1.astUtils.findMatches(p, antlr_1.Java9FileParser, javaProjectUtils_1.JavaSourceFiles, UnnecessaryComponentScanAnnotations);
return {
repoId: p.id,
comments: matches.map(m => {
return {
severity: "info",
category: springReviewCategories_1.SpringStyle,
subcategory: exports.UnnecessaryComponentScanCategory,
detail: "`@ComponentScan` annotations are not necessary on `@SpringBootApplication` classes as they are inherited",
sourceLocation: m.sourceLocation,
fix: {
command: "RemoveUnnecessaryComponentScanAnnotations",
params: {
"target.owner": p.id.owner,
"target.repo": p.id.repo,
},
},
};
}),
};
});
exports.UnnecessaryComponentScanReviewer = {
name: "unnecessary-component-scan-reviewer",
inspection: exports.unnecessaryComponentScanReviewer,
};
exports.UnnecessaryComponentScanAutofix = {
name: "Unnecessary @ComponentScan",
transform: exports.removeUnnecessaryComponentScanTransform,
};
//# sourceMappingURL=removeUnnecessaryComponentScanAnnotations.js.map