actions/ssh-key-action
1
0
Fork 0
mirror of https://github.com/shimataro/ssh-key-action.git synced 2025-06-19 22:52:10 +10:00
Code Activity

Change code style to 1TBS

Browse source
This commit is contained in:
shimataro 2022-10-30 17:35:51 +09:00
parent b38d88da8a
commit 37d0a89301
No known key found for this signature in database
GPG key ID: BE92C05736911A9D
4 changed files with 186 additions and 207 deletions
Download patch file Download diff file Expand all files Collapse all files

7
.editorconfig
View file

@ -25,6 +25,13 @@ spaces_around_brackets = none
indent_brace_style = allman indent_brace_style = allman
# JavaScript/TypeScript
[*.{js,ts}]
indent_style = space
curly_bracket_next_line = false
indent_brace_style = K&R
# JSON/YAML # JSON/YAML
[*.{json,babelrc,code-workspace,yml,yaml}] [*.{json,babelrc,code-workspace,yml,yaml}]
indent_style = space indent_style = space

19
.eslintrc.yml
View file

@ -31,7 +31,7 @@ rules: # https://eslint.org/docs/rules/
block-spacing: error block-spacing: error
brace-style: brace-style:
- error - error
- allman - 1tbs
callback-return: error callback-return: error
capitalized-comments: 'off' capitalized-comments: 'off'
class-methods-use-this: error class-methods-use-this: error
@ -87,26 +87,14 @@ rules: # https://eslint.org/docs/rules/
- below - below
indent: indent:
- error - error
- tab - 4
- SwitchCase: 1
indent-legacy: 'off' indent-legacy: 'off'
init-declarations: error init-declarations: error
jsx-quotes: error jsx-quotes: error
key-spacing: error key-spacing: error
keyword-spacing: keyword-spacing:
- error - error
- overrides:
catch:
after: false
for:
after: false
if:
after: false
switch:
after: false
while:
after: false
with:
after: false
line-comment-position: 'off' line-comment-position: 'off'
linebreak-style: linebreak-style:
- error - error
@ -309,6 +297,7 @@ rules: # https://eslint.org/docs/rules/
# @typescript-eslint plugin # @typescript-eslint plugin
"@typescript-eslint/ban-ts-ignore": 'off' "@typescript-eslint/ban-ts-ignore": 'off'
"@typescript-eslint/no-empty-interface": 'off' "@typescript-eslint/no-empty-interface": 'off'
"@typescript-eslint/no-floating-promises": error
"@typescript-eslint/no-use-before-define": "@typescript-eslint/no-use-before-define":
- error - error
- functions: false - functions: false

118
lib/index.js
View file

@ -590,66 +590,61 @@ __nccwpck_require__.r(__webpack_exports__);
* main function * main function
*/ */
function main() { function main() {
try { // parameters
// parameters const key = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("key", {
const key = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("key", { required: true,
required: true, });
const name = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("name");
const knownHosts = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("known_hosts", {
required: true,
});
const config = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("config");
const ifKeyExists = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("if_key_exists");
// create ".ssh" directory
const home = getHomeDirectory();
const dirName = path__WEBPACK_IMPORTED_MODULE_1___default().resolve(home, ".ssh");
fs__WEBPACK_IMPORTED_MODULE_0___default().mkdirSync(dirName, {
recursive: true,
mode: 0o700,
});
// files to be created
const files = [];
if (shouldCreateKeyFile(path__WEBPACK_IMPORTED_MODULE_1___default().join(dirName, name), ifKeyExists)) {
files.push({
name: name,
contents: insertLf(key, false, true),
options: {
mode: 0o400,
flag: "wx",
},
}); });
const name = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("name");
const knownHosts = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("known_hosts", {
required: true,
});
const config = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("config");
const ifKeyExists = _actions_core__WEBPACK_IMPORTED_MODULE_2__.getInput("if_key_exists");
// create ".ssh" directory
const home = getHomeDirectory();
const dirName = path__WEBPACK_IMPORTED_MODULE_1___default().resolve(home, ".ssh");
fs__WEBPACK_IMPORTED_MODULE_0___default().mkdirSync(dirName, {
recursive: true,
mode: 0o700,
});
// files to be created
const files = [];
if (shouldCreateKeyFile(path__WEBPACK_IMPORTED_MODULE_1___default().join(dirName, name), ifKeyExists)) {
files.push({
name: name,
contents: insertLf(key, false, true),
options: {
mode: 0o400,
flag: "wx",
},
});
}
if (knownHosts !== "unnecessary") {
files.push({
name: "known_hosts",
contents: insertLf(knownHosts, true, true),
options: {
mode: 0o644,
flag: "a",
},
});
}
if (config !== "") {
files.push({
name: "config",
contents: insertLf(config, true, true),
options: {
mode: 0o644,
flag: "a",
},
});
}
// create files
for (const file of files) {
const fileName = path__WEBPACK_IMPORTED_MODULE_1___default().join(dirName, file.name);
fs__WEBPACK_IMPORTED_MODULE_0___default().writeFileSync(fileName, file.contents, file.options);
}
console.log(`SSH key has been stored to ${dirName} successfully.`);
} }
catch (err) { if (knownHosts !== "unnecessary") {
_actions_core__WEBPACK_IMPORTED_MODULE_2__.setFailed(err.message); files.push({
name: "known_hosts",
contents: insertLf(knownHosts, true, true),
options: {
mode: 0o644,
flag: "a",
},
});
} }
if (config !== "") {
files.push({
name: "config",
contents: insertLf(config, true, true),
options: {
mode: 0o644,
flag: "a",
},
});
}
// create files
for (const file of files) {
const fileName = path__WEBPACK_IMPORTED_MODULE_1___default().join(dirName, file.name);
fs__WEBPACK_IMPORTED_MODULE_0___default().writeFileSync(fileName, file.contents, file.options);
}
console.log(`SSH key has been stored to ${dirName} successfully.`);
} }
/** /**
* get home directory * get home directory
@ -724,7 +719,14 @@ function shouldCreateKeyFile(keyFilePath, ifKeyExists) {
throw new Error(`SSH key is already installed. Set "if_key_exists" to "replace" or "ignore" in order to avoid this error.`); throw new Error(`SSH key is already installed. Set "if_key_exists" to "replace" or "ignore" in order to avoid this error.`);
} }
} }
main(); try {
main();
}
catch (err) {
if (err instanceof Error) {
_actions_core__WEBPACK_IMPORTED_MODULE_2__.setFailed(err);
}
}
})(); })();

249
src/main.ts
View file

@ -3,126 +3,108 @@ import path from "path";
import * as core from "@actions/core"; import * as core from "@actions/core";
interface FileInfo interface FileInfo {
{ name: string;
name: string; contents: string;
contents: string; options: fs.WriteFileOptions;
options: fs.WriteFileOptions;
} }
/** /**
* main function * main function
*/ */
function main(): void function main(): void {
{ // parameters
try const key = core.getInput("key", {
{ required: true,
// parameters });
const key = core.getInput("key", { const name = core.getInput("name");
required: true, const knownHosts = core.getInput("known_hosts", {
}); required: true,
const name = core.getInput("name"); });
const knownHosts = core.getInput("known_hosts", { const config = core.getInput("config");
required: true, const ifKeyExists = core.getInput("if_key_exists");
});
const config = core.getInput("config");
const ifKeyExists = core.getInput("if_key_exists");
// create ".ssh" directory // create ".ssh" directory
const home = getHomeDirectory(); const home = getHomeDirectory();
const dirName = path.resolve(home, ".ssh"); const dirName = path.resolve(home, ".ssh");
fs.mkdirSync(dirName, { fs.mkdirSync(dirName, {
recursive: true, recursive: true,
mode: 0o700, mode: 0o700,
}); });
// files to be created // files to be created
const files: FileInfo[] = []; const files: FileInfo[] = [];
if(shouldCreateKeyFile(path.join(dirName, name), ifKeyExists)) if (shouldCreateKeyFile(path.join(dirName, name), ifKeyExists)) {
{ files.push({
files.push({ name: name,
name: name, contents: insertLf(key, false, true),
contents: insertLf(key, false, true), options: {
options: { mode: 0o400,
mode: 0o400, flag: "wx",
flag: "wx", },
}, });
}); }
} if (knownHosts !== "unnecessary") {
if(knownHosts !== "unnecessary") files.push({
{ name: "known_hosts",
files.push({ contents: insertLf(knownHosts, true, true),
name: "known_hosts", options: {
contents: insertLf(knownHosts, true, true), mode: 0o644,
options: { flag: "a",
mode: 0o644, },
flag: "a", });
}, }
}); if (config !== "") {
} files.push({
if(config !== "") name: "config",
{ contents: insertLf(config, true, true),
files.push({ options: {
name: "config", mode: 0o644,
contents: insertLf(config, true, true), flag: "a",
options: { },
mode: 0o644, });
flag: "a", }
},
});
}
// create files // create files
for(const file of files) for (const file of files) {
{ const fileName = path.join(dirName, file.name);
const fileName = path.join(dirName, file.name); fs.writeFileSync(fileName, file.contents, file.options);
fs.writeFileSync(fileName, file.contents, file.options); }
}
console.log(`SSH key has been stored to ${dirName} successfully.`); console.log(`SSH key has been stored to ${dirName} successfully.`);
}
catch(err)
{
core.setFailed(err.message);
}
} }
/** /**
* get home directory * get home directory
* @returns home directory * @returns home directory
*/ */
function getHomeDirectory(): string function getHomeDirectory(): string {
{ const homeEnv = getHomeEnv();
const homeEnv = getHomeEnv(); const home = process.env[homeEnv];
const home = process.env[homeEnv]; if (home === undefined) {
if(home === undefined) throw Error(`${homeEnv} is not defined`);
{ }
throw Error(`${homeEnv} is not defined`);
}
if(home === "/github/home") if (home === "/github/home") {
{ // Docker container
// Docker container return "/root";
return "/root"; }
}
return home; return home;
} }
/** /**
* get HOME environment name * get HOME environment name
* @returns HOME environment name * @returns HOME environment name
*/ */
function getHomeEnv(): string function getHomeEnv(): string {
{ if (process.platform === "win32") {
if(process.platform === "win32") // Windows
{ return "USERPROFILE";
// Windows }
return "USERPROFILE";
}
// macOS / Linux // macOS / Linux
return "HOME"; return "HOME";
} }
/** /**
@ -132,25 +114,21 @@ function getHomeEnv(): string
* @param append true to append * @param append true to append
* @returns new value * @returns new value
*/ */
function insertLf(value: string, prepend: boolean, append: boolean): string function insertLf(value: string, prepend: boolean, append: boolean): string {
{ let affectedValue = value;
let affectedValue = value;
if(value.length === 0) if (value.length === 0) {
{ // do nothing if empty
// do nothing if empty return "";
return ""; }
} if (prepend && !affectedValue.startsWith("\n")) {
if(prepend && !affectedValue.startsWith("\n")) affectedValue = `\n${affectedValue}`;
{ }
affectedValue = `\n${affectedValue}`; if (append && !affectedValue.endsWith("\n")) {
} affectedValue = `${affectedValue}\n`;
if(append && !affectedValue.endsWith("\n")) }
{
affectedValue = `${affectedValue}\n`;
}
return affectedValue; return affectedValue;
} }
/** /**
@ -159,29 +137,32 @@ function insertLf(value: string, prepend: boolean, append: boolean): string
* @param ifKeyExists action if SSH key exists * @param ifKeyExists action if SSH key exists
* @returns Yes/No * @returns Yes/No
*/ */
function shouldCreateKeyFile(keyFilePath: string, ifKeyExists: string): boolean function shouldCreateKeyFile(keyFilePath: string, ifKeyExists: string): boolean {
{ if (!fs.existsSync(keyFilePath)) {
if(!fs.existsSync(keyFilePath)) // should create if file does not exist
{ return true;
// should create if file does not exist }
return true;
}
switch(ifKeyExists) switch (ifKeyExists) {
{ case "replace":
case "replace": // remove file and should create if replace
// remove file and should create if replace fs.unlinkSync(keyFilePath);
fs.unlinkSync(keyFilePath); return true;
return true;
case "ignore": case "ignore":
// should NOT create if ignore // should NOT create if ignore
return false; return false;
default: default:
// error otherwise // error otherwise
throw new Error(`SSH key is already installed. Set "if_key_exists" to "replace" or "ignore" in order to avoid this error.`); throw new Error(`SSH key is already installed. Set "if_key_exists" to "replace" or "ignore" in order to avoid this error.`);
} }
} }
main(); try {
main();
} catch (err) {
if (err instanceof Error) {
core.setFailed(err);
}
}