Skip to content

Commit

Permalink
#47: introducing the new js plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
joshradin committed Oct 12, 2022
1 parent c9bea15 commit ba40355
Show file tree
Hide file tree
Showing 14 changed files with 294 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/target
.assemble
/build
/build
node_modules
1 change: 1 addition & 0 deletions .idea/assemble-rs.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions crates/assemble-js-plugin/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[package]
name = "assemble-js-plugin"
version = "0.1.0"
edition = "2021"

[lib]
path = "src/rust/lib.rs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
include_dir = "0.7.2"

[build-dependencies]
npm_rs = "0.2.1"
22 changes: 22 additions & 0 deletions crates/assemble-js-plugin/build.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
use npm_rs::{NodeEnv, NpmEnv};
use std::path::Path;
use std::{env, fs};

fn main() {
println!("cargo:rerun-if-changed=package.json");
println!("cargo:rerun-if-changed=src/ts");
println!("cargo:rerun-if-changed=build.rs");

let out_dir = env::var("OUT_DIR").expect("should be set in build script");

fs::remove_dir_all(Path::new(&out_dir).join("js")).expect("couldn't clean");

let result = NpmEnv::default()
.with_node_env(&NodeEnv::Production)
.init_env()
.install(None)
.run(&format!("build -- {out_dir}/js"))
.exec()
.expect("could not run npm command. is npm installed?");
assert!(result.success(), "could not build typescript project")
}
31 changes: 31 additions & 0 deletions crates/assemble-js-plugin/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions crates/assemble-js-plugin/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"dependencies": {
"typescript": "^4.8.4"
},
"scripts": {
"build": "npx tsc -p src/ts/tsconfig.json --outDir"
}
}
44 changes: 44 additions & 0 deletions crates/assemble-js-plugin/src/rust/javascript.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
//! Gets the typescript definitions
use include_dir::Dir;

static TRANSPILED_JAVASCRIPT: Dir<'_> = include_dir::include_dir!("$OUT_DIR/js");

#[cfg(test)]
mod tests {
use crate::javascript::TRANSPILED_JAVASCRIPT;

#[test]
fn files_linked() {
assert!(
TRANSPILED_JAVASCRIPT.entries().len() > 0,
"no files detected"
);
}

#[test]
fn get_project_js() {
let project_js = TRANSPILED_JAVASCRIPT
.get_file("project.js")
.expect("project.js file should exist");
let string = project_js.contents_utf8().unwrap();
println!("{}", string);
assert!(
string.contains("class Project"),
"should contain project definition"
);
}

#[test]
fn get_task_js() {
let project_js = TRANSPILED_JAVASCRIPT
.get_file("tasks/task.js")
.expect("tasks/task.js file should exist");
let string = project_js.contents_utf8().unwrap();
println!("{}", string);
assert!(
string.contains("class DefaultTask"),
"should contain project definition"
);
}
}
1 change: 1 addition & 0 deletions crates/assemble-js-plugin/src/rust/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub mod javascript;
1 change: 1 addition & 0 deletions crates/assemble-js-plugin/src/ts/delegate.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
type Delegate<T, R = any> = ((this: T) => R)| ((value: T) => R);
10 changes: 10 additions & 0 deletions crates/assemble-js-plugin/src/ts/project.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
class Project {
readonly name: string;
private path: string | null = null;

constructor(name: string) {
this.name = name
}
}


1 change: 1 addition & 0 deletions crates/assemble-js-plugin/src/ts/tasks/actions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
type TaskAction<T extends Task<T>> = Delegate<T, void>;
38 changes: 38 additions & 0 deletions crates/assemble-js-plugin/src/ts/tasks/task.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
interface Task<T extends Task<T>> {
readonly name: String

get actions(): [TaskAction<T>] | [];

doFirst(callback: TaskAction<T>): void;
doLast(callback: TaskAction<T>): void;

}

class DefaultTask implements Task<DefaultTask> {

readonly name: String;


constructor(name: String) {
this.name = name;
}

doFirst(callback: TaskAction<DefaultTask>): void {
}

doLast(callback: TaskAction<DefaultTask>): void {
}

get actions(): [TaskAction<DefaultTask>] | [] {
return [];
}
}

class WriteTask extends DefaultTask {

}

let def = new DefaultTask("task");
def.doFirst((task: WriteTask) => {

})
103 changes: 103 additions & 0 deletions crates/assemble-js-plugin/src/ts/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2020", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

0 comments on commit ba40355

Please sign in to comment.