Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Testing substituing file content #36

Merged
merged 8 commits into from
Apr 29, 2024
Merged

Testing substituing file content #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9b30c2f
chore(deps): Add test dependencies
caffeine-addictt Apr 29, 2024
7c4fbfd
refactor: Abstract to files
caffeine-addictt Apr 29, 2024
9897c9c
feat: Enable/Disable auto cleanup
caffeine-addictt Apr 29, 2024
08f6d88
revert: Revert to synchronous
caffeine-addictt Apr 29, 2024
f40cdf8
fix: Make cleanup rm -rf
caffeine-addictt Apr 29, 2024
a277a65
test: Remove setup test
caffeine-addictt Apr 29, 2024
9e85a48
test: Add io-util test
caffeine-addictt Apr 29, 2024
a3c839a
chore(build): Build dist
caffeine-addictt Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions babel.config.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
presets: [
['@babel/preset-env', { targets: { node: 'current' } }],
'@babel/preset-typescript',
],
};
12 changes: 12 additions & 0 deletions dist/error.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.handleError = void 0;
/** Handle errors and conditionally exit program */
var handleError = function (error) {
if ((error === null || error === void 0 ? void 0 : error.code) !== 'ENOENT' &&
(error === null || error === void 0 ? void 0 : error.code) !== 'EEXIST') {
console.error(error);
process.exit(1);
}
};
exports.handleError = handleError;
75 changes: 75 additions & 0 deletions dist/io-util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.replaceInFile = exports.withTempDir = void 0;
var fs_1 = require("fs");
var path_1 = require("path");
var stream_1 = require("stream");
var readline_1 = require("readline");
var error_1 = require("./error");
var withTempDir = function (prefix, func, autoCleanup) {
if (autoCleanup === void 0) { autoCleanup = true; }
var dirPath = fs_1.default.mkdtempSync(prefix);
var cleanup = function () { return fs_1.default.rmSync(dirPath, { recursive: true, force: true }); };
return {
path: dirPath,
cleanup: cleanup,
func: function () {
try {
var returnVal = func(dirPath);
if (autoCleanup)
cleanup();
return returnVal;
}
catch (e) {
(0, error_1.handleError)(e);
}
},
};
};
exports.withTempDir = withTempDir;
/** Replace string in file buffer */
var replaceInFile = function (filePath, tempDir, data) {
return new Promise(function (resolve) {
// Revert to legacy
var fileContent = fs_1.default.readFileSync(filePath, 'utf8');
fileContent = fileContent
.replace(/{{REPOSITORY}}/g, data.repository)
.replace(/{{PROJECT_NAME}}/g, data.proj_name)
.replace(/{{PROJECT_SHORT_DESCRIPTION}}/g, data.proj_short_desc)
.replace(/{{PROJECT_LONG_DESCRIPTION}}/g, data.proj_long_desc)
.replace(/{{DOCS_URL}}/g, data.docs_url)
.replace(/{{EMAIL}}/g, data.email)
.replace(/{{USERNAME}}/g, data.username)
.replace(/{{NAME}}/g, data.name);
resolve(fs_1.default.writeFileSync(filePath, fileContent));
return;
// There was an attempt at buffering R/W
var outputPath = path_1.default.join(tempDir, path_1.default.basename(filePath));
fs_1.default.writeFileSync(outputPath, '');
var inStream = fs_1.default.createReadStream(filePath);
var outStream = new stream_1.default.Writable();
readline_1.default
.createInterface({
input: inStream,
output: outStream,
terminal: false,
})
.on('line', function (line) {
fs_1.default.appendFileSync(outputPath, line
.replace(/{{REPOSITORY}}/g, "".concat(data.username, "/").concat(data.repository))
.replace(/{{PROJECT_NAME}}/g, data.proj_name)
.replace(/{{PROJECT_SHORT_DESCRIPTION}}/g, data.proj_short_desc)
.replace(/{{PROJECT_LONG_DESCRIPTION}}/g, data.proj_long_desc)
.replace(/{{DOCS_URL}}/g, data.docs_url)
.replace(/{{EMAIL}}/g, data.email)
.replace(/{{USERNAME}}/g, data.username)
.replace(/{{NAME}}/g, data.name) + '\n');
})
.on('close', function () {
// Move from temp back to original
fs_1.default.renameSync(outputPath, filePath);
resolve();
});
});
};
exports.replaceInFile = replaceInFile;
84 changes: 14 additions & 70 deletions dist/setup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
Object.defineProperty(exports, "__esModule", { value: true });
var fs_1 = require("fs");
var path_1 = require("path");
var stream_1 = require("stream");
var readline_1 = require("readline");
var io_util_1 = require("./io-util");
var error_1 = require("./error");
// Constants
var templateSyncIgnore = "\n.github/ISSUE_TEMPLATE/*\n.github/CODEOWNERS\n.github/CODESTYLE.md\n.github/PULL_REQUEST_TEMPLATE.md\n.github/SECURITY.md\nCITATION.cff\nLICENSE\nREADME.md";
var templateSyncLabel = "\n - name: 'CI: Template Sync'\n color: AEB1C2\n description: Sync with upstream template\n";
/** Handle errors and conditionally exit program */
var handleError = function (error) {
if ((error === null || error === void 0 ? void 0 : error.code) !== 'ENOENT' &&
(error === null || error === void 0 ? void 0 : error.code) !== 'EEXIST') {
console.error(error);
process.exit(1);
}
};
/**
* For interacting with stdin/stdout
*/
Expand All @@ -62,55 +55,6 @@ var rl = readline_1.default.createInterface({
var question = function (query) {
return new Promise(function (resolve) { return rl.question(query, resolve); });
};
var withTempDir = function (prefix, func) {
var dirPath;
var cleanup = function () { return dirPath && fs_1.default.rmdirSync(dirPath); };
return {
cleanup: cleanup,
func: function () {
dirPath = fs_1.default.mkdtempSync(prefix);
try {
var returnVal = func(dirPath);
cleanup();
return returnVal;
}
catch (e) {
handleError(e);
}
},
};
};
/** Replace string in file buffer */
var replaceInFile = function (filePath, tempDir, data) {
return new Promise(function (resolve) {
var outputPath = path_1.default.join(tempDir, path_1.default.basename(filePath));
fs_1.default.writeFileSync(outputPath, '');
var inStream = fs_1.default.createReadStream(filePath);
var outStream = new stream_1.default.Writable();
readline_1.default
.createInterface({
input: inStream,
output: outStream,
terminal: false,
})
.on('line', function (line) {
fs_1.default.appendFileSync(outputPath, line
.replace(/{{REPOSITORY}}/g, "".concat(data.username, "/").concat(data.repository))
.replace(/{{PROJECT_NAME}}/g, data.proj_name)
.replace(/{{PROJECT_SHORT_DESCRIPTION}}/g, data.proj_short_desc)
.replace(/{{PROJECT_LONG_DESCRIPTION}}/g, data.proj_long_desc)
.replace(/{{DOCS_URL}}/g, data.docs_url)
.replace(/{{EMAIL}}/g, data.email)
.replace(/{{USERNAME}}/g, data.username)
.replace(/{{NAME}}/g, data.name) + '\n');
})
.on('close', function () {
// Move from temp back to original
fs_1.default.renameSync(outputPath, filePath);
resolve();
});
});
};
/** Ask for project information */
var fetchInfo = function (cleanup) { return __awaiter(void 0, void 0, void 0, function () {
var name, email, username, repository, proj_name, proj_short_desc, proj_long_desc, docs_url;
Expand Down Expand Up @@ -174,7 +118,7 @@ var fetchInfo = function (cleanup) { return __awaiter(void 0, void 0, void 0, fu
/**
* The main logic
*/
var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return __awaiter(void 0, void 0, void 0, function () {
var main = (0, io_util_1.withTempDir)('caffeine-addictt-template-', function (tempDir) { return __awaiter(void 0, void 0, void 0, function () {
var data, filesToUpdate, filesToMove;
return __generator(this, function (_a) {
switch (_a.label) {
Expand All @@ -186,7 +130,7 @@ var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return
recursive: true,
});
filesToUpdate.forEach(function (relativePath) { return __awaiter(void 0, void 0, void 0, function () {
var filePath, fileInfo, error_1;
var filePath, fileInfo, error_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
Expand All @@ -198,16 +142,16 @@ var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return
if (fileInfo.isDirectory()) {
return [2 /*return*/];
}
return [4 /*yield*/, replaceInFile(filePath, tempDir, data)];
return [4 /*yield*/, (0, io_util_1.replaceInFile)(filePath, tempDir, data)];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
error_1 = _a.sent();
error_2 = _a.sent();
// it's a bit different here, won't touch this for now
if ((error_1 === null || error_1 === void 0 ? void 0 : error_1.code) !== 'ENOENT' &&
(error_1 === null || error_1 === void 0 ? void 0 : error_1.code) !== 'EEXIST') {
console.error(error_1);
if ((error_2 === null || error_2 === void 0 ? void 0 : error_2.code) !== 'ENOENT' &&
(error_2 === null || error_2 === void 0 ? void 0 : error_2.code) !== 'EEXIST') {
console.error(error_2);
process.exit(1);
}
else {
Expand Down Expand Up @@ -245,7 +189,7 @@ var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return
console.log('You can view more configuration here: https://github.com/AndreasAugustin/actions-template-sync');
}
catch (error) {
handleError(error);
(0, error_1.handleError)(error);
}
}
else {
Expand All @@ -254,7 +198,7 @@ var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return
fs_1.default.unlinkSync('./template/.github/workflows/sync-template.yml');
}
catch (error) {
handleError(error);
(0, error_1.handleError)(error);
}
}
// Move from template
Expand All @@ -269,7 +213,7 @@ var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return
fs_1.default.renameSync('./template/.github', '.github');
}
catch (error) {
handleError(error);
(0, error_1.handleError)(error);
}
// Clean up development stuff
console.log('Cleaning up...');
Expand All @@ -290,15 +234,15 @@ var main = withTempDir('caffeine-addictt-template-', function (tempDir) { return
fs_1.default.rmSync('node_modules', { recursive: true });
}
catch (error) {
handleError(error);
(0, error_1.handleError)(error);
}
// Clean up dist
try {
fs_1.default.unlinkSync(__filename);
fs_1.default.rmSync('dist', { recursive: true });
}
catch (error) {
handleError(error);
(0, error_1.handleError)(error);
}
// Final stdout
console.log('\nDone!\nIf you encounter any issues, please report it here: https://github.com/caffeine-addictt/template/issues/new?assignees=caffeine-addictt&labels=Type%3A+Bug&projects=&template=1-bug-report.md&title=[Bug]+');
Expand Down
3 changes: 3 additions & 0 deletions dist/types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
"use strict";
// Place some shared types here
Object.defineProperty(exports, "__esModule", { value: true });
2 changes: 1 addition & 1 deletion eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'

export default [
{
ignores: ['dist/*'],
ignores: ['dist/*', 'babel.config.cjs'],
},
configs.recommended,
..._configs.recommended,
Expand Down
Loading
Loading