declapract
Version:
A tool to declaratively define best practices, maintainable evolve them, and scalably enforce them.
103 lines • 6.53 kB
JavaScript
;
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 });
exports.getHydratedCheckInputsForFile = void 0;
const domain_1 = require("../../../../../domain");
const FileCheckDeclarationInput_1 = require("../../../../../domain/objects/FileCheckDeclarationInput");
const doesFileExist_1 = require("../../../../../utils/fileio/doesFileExist");
const importExportsFromFile_1 = require("../../../../../utils/fileio/importExportsFromFile");
const UserInputError_1 = require("../../../../UserInputError");
const getHydratedCheckInputsForFile = (_a) => __awaiter(void 0, [_a], void 0, function* ({ declaredProjectDirectory, declaredFileCorePath, }) {
// check if user declared input for this file-check
const inputFilePath = `${declaredProjectDirectory}/${declaredFileCorePath}.declapract.ts`; // e.g., the metadata for `tsconfig.ts` is found under `tsconfig.ts.declapract.ts`
const inputFileExists = yield (0, doesFileExist_1.doesFileExist)({ filePath: inputFilePath });
if (!inputFileExists)
return {
declaredCheckInputs: null,
declaredFixFunction: null,
declaredContentsFunction: null,
};
// grab the input file exports
const declaredExports = yield (0, importExportsFromFile_1.importExportsFromFile)({ filePath: inputFilePath });
if (!declaredExports)
return {
declaredCheckInputs: null,
declaredFixFunction: null,
declaredContentsFunction: null,
};
// make sure that check is defined
if (!declaredExports.check)
throw new UserInputError_1.UserInputError(`a '*.declapract.ts' file was defined for '${declaredFileCorePath}' but it did not export a 'check' variable`, {
potentialSolution: `please 'export const check: FileCheckType | FileCheckFunction = ...' from '${inputFilePath}'`,
});
// determine the check inputs user requested
const declaredCheckInputs = (() => {
// handle shorthand of the check type defined
if ((0, domain_1.isOfFileCheckType)(declaredExports.check)) {
if (declaredExports.check === domain_1.FileCheckType.CUSTOM)
// complain if user defined the type in shorthand as CUSTOM - since we dont know what the custom function is then!
throw new UserInputError_1.UserInputError('file check type can not be CUSTOM without the function being specified', {
potentialSolution: 'consider defining the check function, type FileCheckFunction, instead',
});
return new FileCheckDeclarationInput_1.FileCheckDeclarationInput({
type: declaredExports.check,
});
}
// handle shorthand of custom function defined
if (typeof declaredExports.check === 'function') {
return new FileCheckDeclarationInput_1.FileCheckDeclarationInput({
type: domain_1.FileCheckType.CUSTOM,
function: declaredExports.check,
});
}
// check that user did not try to define a custom function with a non CUSTOM type
if (declaredExports.check.type && // type is defined
declaredExports.check.function && // and custom function is defined
declaredExports.check.type !== domain_1.FileCheckType.CUSTOM // but type is not custom
)
throw new UserInputError_1.UserInputError('if check.function is defined then the type can not be defined as anything but FileCheckType.CUSTOM', {
potentialSolution: 'you can remove the check.type declaration, specify check.type = FileCheckType.CUSTOM explicitly, or not use a custom check function',
});
// handle the remaining case, object was defined in full
try {
return new FileCheckDeclarationInput_1.FileCheckDeclarationInput(declaredExports.check);
}
catch (error) {
throw new UserInputError_1.UserInputError(`The 'check' variable exported from '*.declapract.ts' for '${declaredFileCorePath}' was not a supported shorthand definition and is not a correctly defined 'FileCheckDeclarationInput'`, {
potentialSolution: `Please fix the 'export const check = ...' export in '${inputFilePath}'. If you are trying to specify a FileCheckDeclarationInput check object, here is why it was invalid: ${error.message}`,
});
}
})();
// determine if a fix function is defined
const declaredFixFunction = (() => {
if (!declaredExports.fix)
return null;
if (typeof declaredExports.fix !== 'function')
throw new UserInputError_1.UserInputError(`a custom fix function was declared for '${declaredFileCorePath}' but it was not a function`, {
potentialSolution: `please make sure that 'export const fix: FileFixFunction = ...' exports a function from '${inputFilePath}'`,
});
return declaredExports.fix;
})();
// determine if a content function is defined
const declaredContentsFunction = (() => {
if (!declaredExports.contents)
return null;
if (typeof declaredExports.contents !== 'function')
throw new UserInputError_1.UserInputError(`a custom 'content' function was declared for '${declaredFileCorePath}' but it was not a function`, {
potentialSolution: `please make sure that 'export const content: FileContentFunction = ...' exports a function from '${inputFilePath}'`,
});
return declaredExports.contents;
})();
// return both the check inputs and the fix function
return { declaredCheckInputs, declaredFixFunction, declaredContentsFunction };
});
exports.getHydratedCheckInputsForFile = getHydratedCheckInputsForFile;
//# sourceMappingURL=getHydratedCheckInputsForFile.js.map