@stepzen/transpiler 0.0.24 → 0.0.28

package/lib/actions/configure.js

@@ -5,6 +5,7 @@ const debug = require("debug");
 const fs = require("fs-extra");
 const glob = require("glob");
 const inquirer = require("inquirer");
+const path = require("path");
 const yaml = require("yaml");
 exports.default = async (source, silent = false, answers = {}) => {
     var e_1, _a, e_2, _b;
@@ -15,9 +16,10 @@ exports.default = async (source, silent = false, answers = {}) => {
     };
     // Now let's parse and add any config.yamls
     for (const y of glob.sync("**/config.yaml", { cwd: source })) {
-        const file = fs.readFileSync(`${source}/${y}`, "utf8");
+        const filePath = path.join(source, y);
+        const file = fs.readFileSync(filePath, "utf8");
         const asYAML = yaml.parse(file);
-        debug('stepzen:transpiler')(`Adding config.yaml ${source}/${y}`);
+        debug('stepzen:transpiler')(`Adding config.yaml ${filePath}`);
         debug('stepzen:transpiler')(`Contents: ${JSON.stringify(asYAML, null, 2)}`);
         if (asYAML.configurationset) {
             config.configurationset = config.configurationset.concat(asYAML.configurationset);
@@ -32,9 +34,10 @@ exports.default = async (source, silent = false, answers = {}) => {
             cwd: source,
         })), _h; _h = await _g.next(), !_h.done;) {
             const j = _h.value;
-            const file = fs.readFileSync(`${source}/${j}`, "utf8");
+            const filePath = path.join(source, j);
+            const file = fs.readFileSync(filePath, "utf8");
             const asJSON = JSON.parse(file);
-            debug('stepzen:transpiler')(`Adding stepzen.config.json ${source}/${j}`);
+            debug('stepzen:transpiler')(`Adding stepzen.config.json ${filePath}`);
             debug('stepzen:transpiler')(`Contents: ${JSON.stringify(asJSON, null, 2)}`);
             if ((_c = asJSON.config) === null || _c === void 0 ? void 0 : _c.questions) {
                 try {

package/lib/actions/lint.d.ts

@@ -0,0 +1,4 @@
+declare const _default: (source: string, options?: {
+    extensions: string;
+}) => Promise<void>;
+export default _default;

package/lib/actions/lint.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fetch_1 = require("node-fetch");
+const fs = require("fs-extra");
+const os = require("os");
+const path = require("path");
+const shell = require("shelljs");
+const stitch_1 = require("../actions/stitch");
+exports.default = async (source, options = {
+    extensions: "",
+}) => {
+    if (!fs.existsSync(source)) {
+        throw new Error(`Cannot find source directory ${source}`);
+    }
+    let extensions = options.extensions;
+    if (!extensions) {
+        const response = await node_fetch_1.default('https://www.steprz.net/directives.graphql');
+        extensions = await response.text();
+    }
+    const stitched = stitch_1.default(source);
+    const index = path.join(stitched, 'index.graphql');
+    const graphql = fs.readFileSync(index, 'utf8');
+    const tmp = path.join(os.tmpdir(), `stepzen-lint-${Date.now()}`);
+    fs.ensureDirSync(tmp);
+    const lintFile = path.join(tmp, 'index.graphql');
+    fs.writeFileSync(lintFile, `${extensions}${os.EOL}${os.EOL}${graphql}`);
+    shell.exec(`npx graphql-schema-linter ${lintFile}`, { silent: true }, (code, stdout, stderr) => {
+        console.log(stdout);
+        fs.removeSync(tmp);
+    });
+};

package/lib/actions/merge.js

@@ -5,6 +5,7 @@ const glob = require("glob");
 const merge_1 = require("@graphql-tools/merge");
 const graphql_1 = require("graphql");
 const os = require("os");
+const path = require("path");
 const merge_helpers_1 = require("../utils/merge-helpers");
 const print_1 = require("./print");
 const set_files_in_sdl_1 = require("../utils/set-files-in-sdl");
@@ -27,7 +28,7 @@ exports.default = async (original, imported, options = {
     if (!options.answers)
         options.answers = {};
     if (!options.output)
-        options.output = `${os.tmpdir()}/stepzen-tmp-${Date.now()}`;
+        options.output = path.join(os.tmpdir(), `stepzen-tmp-${Date.now()}`);
     if (!options.silent)
         options.silent = false;
     // Ensure original, importing and output directories exist
@@ -39,8 +40,9 @@ exports.default = async (original, imported, options = {
     // Copy the original into the output.
     fs.copySync(original, options.output);
     // Ensure an index.graphql exists
-    if (!fs.existsSync(`${options.output}/index.graphql`)) {
-        fs.writeFileSync(`${options.output}/index.graphql`, BLANK_INDEX_TEMPLATE);
+    const outputIndex = path.join(options.output, 'index.graphql');
+    if (!fs.existsSync(outputIndex)) {
+        fs.writeFileSync(outputIndex, BLANK_INDEX_TEMPLATE);
     }
     const merged = merge_1.mergeTypeDefs([
         await merge_helpers_1.getSchema(options.output),
@@ -100,19 +102,24 @@ exports.default = async (original, imported, options = {
     };
     // Write the files to the output directory
     cleaned.original.forEach((a) => {
-        fs.ensureFileSync(`${options.output}/${a.file}`);
-        fs.writeFileSync(`${options.output}/${a.file}`, print_1.default(a.ast));
+        // eslint-disable-next-line
+        const file = path.join(options.output, a.file);
+        fs.ensureFileSync(file);
+        fs.writeFileSync(file, print_1.default(a.ast));
     });
     cleaned.imported.forEach((a) => {
-        fs.ensureFileSync(`${options.output}/${imported.name}/${a.file}`);
-        fs.writeFileSync(`${options.output}/${imported.name}/${a.file}`, print_1.default(a.ast));
+        // eslint-disable-next-line
+        const file = path.join(options.output, imported.name, a.file);
+        fs.ensureFileSync(file);
+        fs.writeFileSync(file, print_1.default(a.ast));
     });
     // Make sure all files are referenced in @sdl
     set_files_in_sdl_1.default(options.output);
     // Generate configuration
     const config = await merge_helpers_1.getConfiguration([options.output, imported.source], options.silent, options.answers);
     if (config) {
-        fs.writeFileSync(`${options.output}/config.yaml`, config);
+        const configFile = path.join(options.output, 'config.yaml');
+        fs.writeFileSync(configFile, config);
     }
     // Return a merged schema!
     return options.output;

package/lib/actions/stitch.js

@@ -5,9 +5,10 @@ const graphql_1 = require("graphql");
 const fs = require("fs-extra");
 const glob = require("glob");
 const os = require("os");
+const path = require("path");
 const prettier = require("prettier");
 const dedupe_query_and_mutation_types_1 = require("../utils/dedupe-query-and-mutation-types");
-exports.default = (source, output = `${os.tmpdir()}/stepzen-tmp-${Date.now()}`) => {
+exports.default = (source, output = path.join(os.tmpdir(), `stepzen-tmp-${Date.now()}`)) => {
     // Ensure source and output directories exist
     if (!fs.existsSync(source))
         throw new Error(`Cannot find source directory ${source}`);
@@ -16,8 +17,9 @@ exports.default = (source, output = `${os.tmpdir()}/stepzen-tmp-${Date.now()}`)
     let ast;
     let files = [];
     // If there's an index.graphQL - get files argument in @sdl directive
-    if (fs.existsSync(`${source}/index.graphql`)) {
-        const index = fs.readFileSync(`${source}/index.graphql`, "utf8");
+    const sourceIndex = path.join(source, 'index.graphql');
+    if (fs.existsSync(sourceIndex)) {
+        const index = fs.readFileSync(sourceIndex, "utf8");
         ast = graphql_1.parse(index);
         ast = graphql_1.visit(ast, {
             Directive(node) {
@@ -45,7 +47,7 @@ exports.default = (source, output = `${os.tmpdir()}/stepzen-tmp-${Date.now()}`)
             const graphql = fs.readFileSync(`${source}/${file}`, "utf8");
             return graphql;
         });
-        ast = graphql_1.parse(content.join("\n"));
+        ast = graphql_1.parse(content.join(os.EOL));
     }
     // Strip @sdl directive
     ast = graphql_1.visit(ast, {
@@ -56,26 +58,31 @@ exports.default = (source, output = `${os.tmpdir()}/stepzen-tmp-${Date.now()}`)
     });
     // Check all the files exist
     for (const file of files) {
-        if (!fs.existsSync(`${source}/${file}`)) {
-            throw new Error(`Cannot find file ${file}`);
+        const find = path.join(source, file);
+        if (!fs.existsSync(find)) {
+            throw new Error(`Cannot find file ${find}`);
         }
     }
     // Get all the files and stitch
     const printed = graphql_1.print(ast);
-    let stitched = `${printed}\n`;
+    let stitched = `${printed}${os.EOL}`;
     for (const file of files) {
-        const content = fs.readFileSync(`${source}/${file}`, "utf8");
-        stitched += `${content}\n`;
+        const find = path.join(source, file);
+        const content = fs.readFileSync(find, "utf8");
+        stitched += `${content}${os.EOL}`;
     }
     // Dedupe Query and Mutation types
     stitched = dedupe_query_and_mutation_types_1.default(stitched);
     // Format
     stitched = prettier.format(stitched, { parser: "graphql" });
     // Write to output folder
-    fs.writeFileSync(`${output}/index.graphql`, stitched);
+    const outputIndex = path.join(output, 'index.graphql');
+    fs.writeFileSync(outputIndex, stitched);
     // Copy config if exists, too
-    if (fs.existsSync(`${source}/config.yaml`)) {
-        fs.copyFileSync(`${source}/config.yaml`, `${output}/config.yaml`);
+    const sourceConfig = path.join(source, 'config.yaml');
+    const outputConfig = path.join(output, 'config.yaml');
+    if (fs.existsSync(sourceConfig)) {
+        fs.copyFileSync(sourceConfig, outputConfig);
     }
     // Return output folder
     return output;

package/lib/actions/transpile.js

@@ -49,7 +49,8 @@ exports.default = async (source) => {
     let mutated = '';
     if (graphqlFiles.length > 0) {
         const stitched = await stitch_1.default(source);
-        const graphql = fs.readFileSync(`${stitched}/index.graphql`, "utf8");
+        const index = path.join(stitched, 'index.graphql');
+        const graphql = fs.readFileSync(index, "utf8");
         let ast = graphql_1.parse(graphql);
         original = graphql_1.parse(graphql);
         // you can transpile schema ast here

package/lib/actions/validate.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const graphql_1 = require("graphql");
 const fs = require("fs-extra");
+const os = require("os");
+const path = require("path");
 const ensure_query_and_mutation_types_1 = require("../utils/ensure-query-and-mutation-types");
 const constants_1 = require("../utils/constants");
 const validators_1 = require("../validators");
@@ -17,9 +19,10 @@ exports.default = (source, options = {
         throw new Error(`Cannot find index.graphql in ${source}`);
     }
     // Get the index.graphql file
-    const index = fs.readFileSync(`${source}/index.graphql`, "utf8");
+    const file = path.join(source, 'index.graphql');
+    const index = fs.readFileSync(file, "utf8");
     // Parse
-    let ast = graphql_1.parse(`${constants_1.EXPERIMENTAL_EXTENSIONS}\n${options.extensions}\n${index}`, {
+    let ast = graphql_1.parse(`${constants_1.EXPERIMENTAL_EXTENSIONS}${os.EOL}${options.extensions}${os.EOL}${index}`, {
         noLocation: true,
     });
     // We make an exception for 'no type Query' or 'no type Mutation'

package/lib/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const configure_1 = require("./actions/configure");
+const lint_1 = require("./actions/lint");
 const merge_1 = require("./actions/merge");
 const print_1 = require("./actions/print");
 const stitch_1 = require("./actions/stitch");
@@ -8,6 +9,7 @@ const transpile_1 = require("./actions/transpile");
 const validate_1 = require("./actions/validate");
 module.exports = {
     configure: configure_1.default,
+    lint: lint_1.default,
     merge: merge_1.default,
     print: print_1.default,
     stitch: stitch_1.default,

package/lib/utils/merge-helpers.js

@@ -7,6 +7,7 @@ const node_fetch_1 = require("node-fetch");
 const fs = require("fs-extra");
 const glob = require("glob");
 const os = require("os");
+const path = require("path");
 const graphql_helpers_1 = require("../utils/graphql-helpers");
 const constants_1 = require("./constants");
 const configure_1 = require("../actions/configure");
@@ -46,7 +47,7 @@ const findTypeInSchema = (name, files) => {
 };
 exports.findTypeInSchema = findTypeInSchema;
 const getConfiguration = async (directories, silent = false, answers = {}) => {
-    const tmp = `${os.tmpdir()}/stepzen-tmp-config-${Date.now()}`;
+    const tmp = path.join(os.tmpdir(), `stepzen-tmp-config-${Date.now()}`);
     fs.ensureDirSync(tmp);
     for (const directory of directories) {
         const configs = [
@@ -54,9 +55,11 @@ const getConfiguration = async (directories, silent = false, answers = {}) => {
             ...glob.sync("**/stepzen.config.json", { cwd: directory }),
         ];
         for (const config of configs) {
-            const content = fs.readFileSync(`${directory}/${config}`, "utf8");
-            fs.ensureFileSync(`${tmp}/${directory}/${config}`);
-            fs.writeFileSync(`${tmp}/${directory}/${config}`, content);
+            const configFolder = path.join(directory, config);
+            const writeFolder = path.join(tmp, directory, config);
+            const content = fs.readFileSync(configFolder, "utf8");
+            fs.ensureFileSync(writeFolder);
+            fs.writeFileSync(writeFolder, content);
         }
     }
     const configuration = await configure_1.default(tmp, silent, answers);
@@ -74,7 +77,7 @@ exports.getExtensions = getExtensions;
 const getSchema = async (directory) => {
     const extensions = await exports.getExtensions();
     const transpiled = await transpile_1.default(directory);
-    return utilities_1.buildSchema(`${extensions}\n${transpiled.schema}`);
+    return utilities_1.buildSchema(`${extensions}${os.EOL}${transpiled.schema}`);
 };
 exports.getSchema = getSchema;
 const mergeQueryMutationIntoSchema = (type, files) => {

package/lib/utils/set-files-in-sdl.js

@@ -3,13 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const glob = require("glob");
 const graphql_1 = require("graphql");
+const path = require("path");
 const graphql_helpers_1 = require("./graphql-helpers");
 const print_1 = require("../actions/print");
 exports.default = (source) => {
     const files = glob
         .sync("**/*.graphql", { cwd: source })
         .filter((file) => file !== "index.graphql");
-    const index = fs.readFileSync(`${source}/index.graphql`, "utf8");
+    const output = path.join(source, 'index.graphql');
+    const index = fs.readFileSync(output, "utf8");
     let ast = graphql_1.parse(index);
     ast = graphql_1.visit(ast, {
         Directive(node) {
@@ -28,5 +30,5 @@ exports.default = (source) => {
             }
         },
     });
-    fs.writeFileSync(`${source}/index.graphql`, print_1.default(ast));
+    fs.writeFileSync(output, print_1.default(ast));
 };

package/lib/validators/config-exists/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const graphql_1 = require("graphql");
 const lodash_1 = require("lodash");
 const fs = require("fs");
+const path = require("path");
 const yaml = require("yaml");
 const STEPZEN_DEFAULTS = [
     'fedex_default',
@@ -27,10 +28,11 @@ exports.default = (ast, source) => {
     configs = lodash_1.uniq(configs);
     configs = lodash_1.filter(configs, (config) => !STEPZEN_DEFAULTS.includes(config));
     if (configs.length > 0) {
-        if (!fs.existsSync(`${source}/config.yaml`)) {
+        const sourceConfig = path.join(source, 'config.yaml');
+        if (!fs.existsSync(sourceConfig)) {
             throw new Error('No config.yaml found');
         }
-        const content = fs.readFileSync(`${source}/config.yaml`, 'utf8');
+        const content = fs.readFileSync(sourceConfig, 'utf8');
         const asYaml = yaml.parse(content);
         for (const config of configs) {
             const found = (_a = asYaml === null || asYaml === void 0 ? void 0 : asYaml.configurationset) === null || _a === void 0 ? void 0 : _a.find((c) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stepzen/transpiler",
   "description": "The StepZen transpiler",
-  "version": "0.0.24",
+  "version": "0.0.28",
   "author": "Darren Waddell <darren@stepzen.com>",
   "license": "MIT",
   "files": [
@@ -27,6 +27,7 @@
     "lodash": "^4.17.21",
     "node-fetch": "^2.6.1",
     "prettier": "^2.2.1",
+    "shelljs": "^0.8.4",
     "yaml": "^1.10.2"
   },
   "devDependencies": {
@@ -39,6 +40,7 @@
     "@types/mock-fs": "^4.13.0",
     "@types/node-fetch": "^2.5.10",
     "@types/prettier": "^2.2.3",
+    "@types/shelljs": "^0.8.9",
     "chai": "^4.3.4",
     "fancy-test": "^1.4.10",
     "mocha": "^9.0.1",