@atomist/sdm-pack-aspect
Version:
an Atomist SDM Extension Pack for visualizing drift across an organization
73 lines • 3 kB
JavaScript
;
/*
* Copyright © 2019 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 sdm_pack_fingerprint_1 = require("@atomist/sdm-pack-fingerprint");
exports.CodeOfConductType = "code-of-conduct";
/**
* Find a code of conduct in a repository if possible.
* Returns no fingerprint if the repository lacks a code of conduct file.
* @constructor
*/
function codeOfConduct(opts = { classifier: extractTitle }) {
return {
name: exports.CodeOfConductType,
displayName: "Code of conduct",
baseOnly: true,
extract: (p) => __awaiter(this, void 0, void 0, function* () {
const codeOfConductFile = yield p.getFile("CODE_OF_CONDUCT.md");
if (codeOfConductFile) {
const content = yield codeOfConductFile.getContent();
const data = {
title: extractTitle(content),
content,
};
return sdm_pack_fingerprint_1.fingerprintOf({
type: exports.CodeOfConductType,
data,
});
}
return undefined;
}),
toDisplayableFingerprintName: () => "Code of conduct",
toDisplayableFingerprint: fpi => {
return fpi.data.title || "untitled";
},
};
}
exports.codeOfConduct = codeOfConduct;
const markdownTitleRegex = /^# (.*)\n/;
/**
* Try to extract the title from this markdown document
* @param {string} mdString
* @return {string | undefined}
*/
function extractTitle(mdString) {
const match = markdownTitleRegex.exec(mdString);
return (match && match.length === 2) ?
match[1] :
undefined;
}
//# sourceMappingURL=codeOfConduct.js.map