starred/windmill
1
0
Fork 0
mirror of https://github.com/windmill-labs/windmill.git synced 2026-08-18 16:02:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): make default typescript configurable

Browse Source
This commit is contained in:
Ruben Fiszel
2024-01-27 20:29:31 +01:00
parent 414ebee0f1
commit 59bbff662e
8 changed files with 69 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/windmill-api/src/workspaces.rs
+16 -2
View File
@@ -1981,6 +1981,7 @@ struct ArchiveQueryParams {
skip_variables: Option<bool>,
skip_resources: Option<bool>,
include_schedules: Option<bool>,
default_ts: Option<String>,
}
#[inline]
@@ -2038,6 +2039,7 @@ async fn tarball_workspace(
skip_secrets,
skip_variables,
include_schedules,
default_ts,
}): Query<ArchiveQueryParams>,
) -> Result<([(headers::HeaderName, String); 2], impl IntoResponse)> {
// require_admin(authed.is_admin, &authed.username)?;
@@ -2087,7 +2089,13 @@ async fn tarball_workspace(
for script in scripts {
let ext = match script.language {
ScriptLang::Python3 => "py",
ScriptLang::Deno => "ts",
ScriptLang::Deno => {
if default_ts.as_ref().is_some_and(|x| x == "bun") {
"deno.ts"
} else {
"ts"
}
}
ScriptLang::Go => "go",
ScriptLang::Bash => "sh",
ScriptLang::Powershell => "ps1",
@@ -2098,7 +2106,13 @@ async fn tarball_workspace(
ScriptLang::Mssql => "ms.sql",
ScriptLang::Graphql => "gql",
ScriptLang::Nativets => "fetch.ts",
ScriptLang::Bun => "bun.ts",
ScriptLang::Bun => {
if default_ts.as_ref().is_some_and(|x| x == "bun") {
"ts"
} else {
"bun.ts"
}
}
};
archive
.write_to_archive(&script.content, &format!("{}.{}", script.path, ext))
cli/bootstrap/script_bootstrap.ts
+1 -2
View File
@@ -4,7 +4,7 @@ export interface ScriptMetadata {
summary: string;
description: string;
lock: string | string[];
is_template: boolean;
is_template?: boolean;
kind: string;
schema: {
$schema: string;
@@ -19,7 +19,6 @@ export function defaultScriptMetadata(): ScriptMetadata {
summary: "",
description: "",
lock: "",
is_template: false,
kind: "script",
schema: {
$schema: "https://json-schema.org/draft/2020-12/schema",
cli/conf.ts
+4 -1
View File
@@ -16,6 +16,7 @@ export interface SyncOptions {
includes?: string[];
extraIncludes?: string[];
excludes?: string[];
defaultTs?: "bun" | "deno";
}
export async function readConfigFile(): Promise<SyncOptions> {
@@ -30,7 +31,9 @@ export async function readConfigFile(): Promise<SyncOptions> {
}
}
export async function mergeConfigWithConfigFile<T>(opts: T): Promise<T> {
export async function mergeConfigWithConfigFile<T>(
opts: T
): Promise<T & SyncOptions> {
const configFile = await readConfigFile();
return Object.assign(configFile, opts);
}
cli/metadata.ts
+2 -1
View File
@@ -32,6 +32,7 @@ export async function generateMetadataInternal(
opts: GlobalOptions & {
lockOnly?: boolean | undefined;
schemaOnly?: boolean | undefined;
defaultTs?: "bun" | "deno";
}
) {
const remotePath = scriptPath
@@ -56,7 +57,7 @@ export async function generateMetadataInternal(
any
>;
const language = inferContentTypeFromFilePath(scriptPath);
const language = inferContentTypeFromFilePath(scriptPath, opts.defaultTs);
if (!opts.lockOnly) {
await updateScriptSchema(
scriptContent,
cli/pull.ts
+3 -2
View File
@@ -10,7 +10,8 @@ export async function downloadZip(
skipVariables?: boolean,
skipResources?: boolean,
skipSecrets?: boolean,
includeSchedules?: boolean
includeSchedules?: boolean,
defaultTs?: "bun" | "deno"
): Promise<JSZip | undefined> {
const requestHeaders: HeadersInit = new Headers();
requestHeaders.set("Authorization", "Bearer " + workspace.token);
@@ -33,7 +34,7 @@ export async function downloadZip(
skipResources ?? false
}&skip_secrets=${skipSecrets ?? false}&include_schedules=${
includeSchedules ?? false
}`,
}&default_ts=${defaultTs ?? "deno"}`,
{
headers: requestHeaders,
method: "GET",
cli/script.ts
+34 -46
View File
@@ -29,6 +29,7 @@ import {
import { elementsToMap } from "./sync.ts";
import { ignoreF } from "./sync.ts";
import { FSFSElement } from "./sync.ts";
import { mergeConfigWithConfigFile, readConfigFile } from "./conf.ts";
export interface ScriptFile {
parent_hash?: string;
@@ -42,6 +43,7 @@ export interface ScriptFile {
type PushOptions = GlobalOptions;
async function push(opts: PushOptions, filePath: string) {
opts = await mergeConfigWithConfigFile(opts);
const workspace = await resolveWorkspace(opts);
if (!validatePath(filePath)) {
@@ -92,17 +94,11 @@ export async function handleFile(
alreadySynced: string[],
message: string | undefined,
lockfileUseArray: boolean,
opts: GlobalOptions | undefined
opts: (GlobalOptions & { defaultTs?: "bun" | "deno" }) | undefined
): Promise<boolean> {
if (
!path.includes(".inline_script.") &&
(path.endsWith(".ts") ||
path.endsWith(".py") ||
path.endsWith(".go") ||
path.endsWith(".sh") ||
path.endsWith(".sql") ||
path.endsWith(".gql") ||
path.endsWith(".ps1"))
exts.some((exts) => path.endsWith(exts))
) {
if (alreadySynced.includes(path)) {
return true;
@@ -119,7 +115,7 @@ export async function handleFile(
opts ? { ...opts, path, workspaceRemote: workspace } : undefined
)
)?.payload;
const language = inferContentTypeFromFilePath(path);
const language = inferContentTypeFromFilePath(path, opts?.defaultTs);
const workspaceId = workspace.workspaceId;
@@ -223,33 +219,9 @@ export async function handleFile(
export async function findContentFile(filePath: string) {
const candidates = filePath.endsWith("script.json")
? [
filePath.replace(".script.json", ".fetch.ts"),
filePath.replace(".script.json", ".bun.ts"),
filePath.replace(".script.json", ".ts"),
filePath.replace(".script.json", ".py"),
filePath.replace(".script.json", ".go"),
filePath.replace(".script.json", ".sh"),
filePath.replace(".script.json", "pg.sql"),
filePath.replace(".script.json", "my.sql"),
filePath.replace(".script.json", "bq.sql"),
filePath.replace(".script.json", "sf.sql"),
filePath.replace(".script.json", ".gql"),
filePath.replace(".script.json", ".ps1"),
]
: [
filePath.replace(".script.yaml", ".fetch.ts"),
filePath.replace(".script.yaml", ".bun.ts"),
filePath.replace(".script.yaml", ".ts"),
filePath.replace(".script.yaml", ".py"),
filePath.replace(".script.yaml", ".go"),
filePath.replace(".script.yaml", ".sh"),
filePath.replace(".script.yaml", "pg.sql"),
filePath.replace(".script.yaml", "bq.sql"),
filePath.replace(".script.yaml", "sf.sql"),
filePath.replace(".script.yaml", ".gql"),
filePath.replace(".script.yaml", ".ps1"),
];
? exts.map((x) => filePath.replace(".script.json", x))
: exts.map((x) => filePath.replace(".script.yaml", x));
const validCandidates = (
await Promise.all(
candidates.map((x) => {
@@ -279,16 +251,25 @@ export async function findContentFile(filePath: string) {
}
export function filePathExtensionFromContentType(
language: ScriptLanguage
language: ScriptLanguage,
defaultTs: "bun" | "deno" | undefined
): string {
if (language === "python3") {
return ".py";
} else if (language === "nativets") {
return ".fetch.ts";
} else if (language === "bun") {
return ".bun.ts";
if (defaultTs == undefined || defaultTs == "deno") {
return ".bun.ts";
} else {
return ".ts";
}
} else if (language === "deno") {
return ".ts";
if (defaultTs == "bun") {
return ".deno.ts";
} else {
return ".ts";
}
} else if (language === "go") {
return ".go";
} else if (language === "mysql") {
@@ -312,24 +293,26 @@ export function filePathExtensionFromContentType(
}
}
export const listValidExtensions = [
".py",
".bun.ts",
const exts = [
".fetch.ts",
".deno.ts",
".bun.ts",
".ts",
".py",
".go",
".sh",
".pg.sql",
".my.sql",
".bq.sql",
"ms.sql",
".pg.sql",
".sf.sql",
".ms.sql",
".sql",
".gql",
".ps1",
];
export function removeExtensionToPath(path: string): string {
for (const ext of listValidExtensions) {
for (const ext of exts) {
if (path.endsWith(ext)) {
return path.substring(0, path.length - ext.length);
}
@@ -530,7 +513,12 @@ async function bootstrap(
throw new Error("Language unknown");
}
const extension = filePathExtensionFromContentType(language);
const config = await readConfigFile();
const extension = filePathExtensionFromContentType(
language,
config.defaultTs
);
const scriptCodeFileFullPath = scriptPath + extension;
const scriptMetadataFileFullPath = scriptPath + ".script.yaml";
cli/script_common.ts
+5 -2
View File
@@ -14,7 +14,8 @@ export type ScriptLanguage =
| "graphql";
export function inferContentTypeFromFilePath(
contentPath: string
contentPath: string,
defaultTs: "bun" | "deno" | undefined
): ScriptLanguage {
if (contentPath.endsWith(".py")) {
return "python3";
@@ -22,8 +23,10 @@ export function inferContentTypeFromFilePath(
return "nativets";
} else if (contentPath.endsWith("bun.ts")) {
return "bun";
} else if (contentPath.endsWith(".ts")) {
} else if (contentPath.endsWith("deno.ts")) {
return "deno";
} else if (contentPath.endsWith(".ts")) {
return defaultTs ?? "deno";
} else if (contentPath.endsWith(".go")) {
return "go";
} else if (contentPath.endsWith(".my.sql")) {
cli/sync.ts
+4 -2
View File
@@ -522,7 +522,8 @@ async function pull(opts: GlobalOptions & SyncOptions) {
opts.skipVariables,
opts.skipResources,
opts.skipSecrets,
opts.includeSchedules
opts.includeSchedules,
opts.defaultTs
))!,
!opts.json
);
@@ -732,7 +733,8 @@ async function push(opts: GlobalOptions & SyncOptions) {
opts.skipVariables,
opts.skipResources,
opts.skipSecrets,
opts.includeSchedules
opts.includeSchedules,
opts.defaultTs
))!,
!opts.json
);