@khanacademy/graphql-flow 3.1.2 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @khanacademy/graphql-flow
 
+## 3.2.0
+
+### Minor Changes
+
+-   96c201e: Add a noComments config option to exclude all comments in the output
+-   7c01b6a: Add a --schema-file graphql argument, and allow exporting a function from the config.js file
+-   96c201e: Add a `noComments` config option to exclude all comments
+
+## 3.1.3
+
+### Patch Changes
+
+-   a8be4ea: Fix file extension toggling, improve file writing.
+
 ## 3.1.2
 
 ### Patch Changes

package/dist/cli/config.js

@@ -3,46 +3,66 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.validateOrThrow = exports.loadConfigFile = exports.getSchemas = exports.findApplicableConfig = void 0;
-
-var _schemaFromIntrospectionData = require("../schemaFromIntrospectionData");
-
+exports.validateOrThrow = exports.parseCliOptions = exports.makeAbsPath = exports.loadConfigFile = exports.getSchemas = exports.getInputFiles = exports.findApplicableConfig = void 0;
 var _schema = _interopRequireDefault(require("../../schema.json"));
-
+var _schemaFromIntrospectionData = require("../schemaFromIntrospectionData");
 var _fs = _interopRequireDefault(require("fs"));
-
 var _graphql = require("graphql");
-
 var _jsonschema = require("jsonschema");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+var _minimist = _interopRequireDefault(require("minimist"));
+var _child_process = require("child_process");
+var _path = _interopRequireDefault(require("path"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const validateOrThrow = (value, jsonSchema) => {
   const result = (0, _jsonschema.validate)(value, jsonSchema);
-
   if (!result.valid) {
     throw new Error(result.errors.map(error => error.toString()).join("\n"));
   }
 };
-
 exports.validateOrThrow = validateOrThrow;
-
-const loadConfigFile = configFile => {
-  const data = require(configFile);
-
+const makeAbsPath = (maybeRelativePath, basePath) => {
+  return _path.default.isAbsolute(maybeRelativePath) ? maybeRelativePath : _path.default.join(basePath, maybeRelativePath);
+};
+exports.makeAbsPath = makeAbsPath;
+const loadConfigFile = options => {
+  let data = require(options.configFilePath);
+  if (typeof data === "function") {
+    data = data(options);
+  } else {
+    if (options.schemaFile) {
+      if (Array.isArray(data.generate)) {
+        data.generate.forEach(item => {
+          item.schemaFilePath = options.schemaFile;
+        });
+      } else {
+        data.generate.schemaFilePath = options.schemaFile;
+      }
+    }
+  }
   validateOrThrow(data, _schema.default);
   return data;
 };
+exports.loadConfigFile = loadConfigFile;
+const findGraphqlTagReferences = root => {
+  // NOTE(john): We want to include untracked files here so that we can
+  // generate types for them. This is useful for when we have a new file
+  // that we want to generate types for, but we haven't committed it yet.
+  const response = (0, _child_process.execSync)("git grep -I --word-regexp --name-only --fixed-strings --untracked 'graphql-tag' -- '*.js' '*.jsx' '*.ts' '*.tsx'", {
+    encoding: "utf8",
+    cwd: root
+  });
+  return response.trim().split("\n").map(relative => _path.default.join(root, relative));
+};
+const getInputFiles = (options, config) => {
+  return options.cliFiles.length ? options.cliFiles : findGraphqlTagReferences(makeAbsPath(config.crawl.root, _path.default.dirname(options.configFilePath)));
+};
+
 /**
  * Loads a .json 'introspection query response', or a .graphql schema definition.
  */
-
-
-exports.loadConfigFile = loadConfigFile;
-
+exports.getInputFiles = getInputFiles;
 const getSchemas = schemaFilePath => {
   const raw = _fs.default.readFileSync(schemaFilePath, "utf8");
-
   if (schemaFilePath.endsWith(".graphql")) {
     const schemaForValidation = (0, _graphql.buildSchema)(raw);
     const queryResponse = (0, _graphql.graphqlSync)({
@@ -60,33 +80,43 @@ const getSchemas = schemaFilePath => {
     return [schemaForValidation, schemaForTypeGeneration];
   }
 };
+exports.getSchemas = getSchemas;
+const parseCliOptions = (argv, relativeBase) => {
+  const args = (0, _minimist.default)(argv);
+  let [configFilePath, ...cliFiles] = args._;
+  if (args.h || args.help || !configFilePath) {
+    return false;
+  }
+  configFilePath = makeAbsPath(configFilePath, relativeBase);
+  const options = {
+    configFilePath,
+    cliFiles
+  };
+  if (args["schema-file"]) {
+    options.schemaFile = args["schema-file"];
+  }
+  return options;
+};
+
 /**
  * Find the first item of the `config.generate` array where both:
  * - no item of `exclude` matches
  * - at least one item of `match` matches
  */
-
-
-exports.getSchemas = getSchemas;
-
+exports.parseCliOptions = parseCliOptions;
 const findApplicableConfig = (path, configs) => {
   if (!Array.isArray(configs)) {
     configs = [configs];
   }
-
   return configs.find(config => {
     var _config$exclude;
-
     if ((_config$exclude = config.exclude) !== null && _config$exclude !== void 0 && _config$exclude.some(exclude => new RegExp(exclude).test(path))) {
       return false;
     }
-
     if (!config.match) {
       return true;
     }
-
     return config.match.some(matcher => new RegExp(matcher).test(path));
   });
 };
-
 exports.findApplicableConfig = findApplicableConfig;

package/dist/cli/run.js

@@ -1,34 +1,19 @@
 #!/usr/bin/env node
-
 /* eslint-disable no-console */
 "use strict";
 
 var _generateTypeFiles = require("../generateTypeFiles");
-
 var _parse = require("../parser/parse");
-
 var _resolve = require("../parser/resolve");
-
 var _utils = require("../parser/utils");
-
 var _config = require("./config");
-
 var _apolloUtilities = require("apollo-utilities");
-
-var _child_process = require("child_process");
-
 var _fs = require("fs");
-
 var _printer = require("graphql/language/printer");
-
 var _validation = require("graphql/validation");
-
 var _path = _interopRequireWildcard(require("path"));
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /**
  * This CLI tool executes the following steps:
  * 1) parse & validate config file
@@ -39,44 +24,29 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  *   the DocumentNodes.
  * 4) generate types for all resolved Queries & Mutations
  */
-
 /** Step (1) */
-const findGraphqlTagReferences = root => {
-  // NOTE(john): We want to include untracked files here so that we can
-  // generate types for them. This is useful for when we have a new file
-  // that we want to generate types for, but we haven't committed it yet.
-  const response = (0, _child_process.execSync)("git grep -I --word-regexp --name-only --fixed-strings --untracked 'graphql-tag' -- '*.js' '*.jsx' '*.ts' '*.tsx'", {
-    encoding: "utf8",
-    cwd: root
-  });
-  return response.trim().split("\n").map(relative => _path.default.join(root, relative));
-};
-
-const [_, __, configFilePath, ...cliFiles] = process.argv;
-
-if (configFilePath === "-h" || configFilePath === "--help" || configFilePath === "help" || !configFilePath) {
+const options = (0, _config.parseCliOptions)(process.argv.slice(2), process.cwd());
+if (options === false) {
   console.log(`graphql-flow
 
-Usage: graphql-flow [configFile.json] [filesToCrawl...]`);
+Usage: graphql-flow [configFile.json] [filesToCrawl...]
+Options:
+  --schema-file: provide a schema file to override the one defined in config`);
   process.exit(1);
 }
+const config = (0, _config.loadConfigFile)(options);
+const inputFiles = (0, _config.getInputFiles)(options, config);
 
-const makeAbsPath = (maybeRelativePath, basePath) => {
-  return _path.default.isAbsolute(maybeRelativePath) ? maybeRelativePath : _path.default.join(basePath, maybeRelativePath);
-};
-
-const absConfigPath = makeAbsPath(configFilePath, process.cwd());
-const config = (0, _config.loadConfigFile)(absConfigPath);
-const inputFiles = cliFiles.length ? cliFiles : findGraphqlTagReferences(makeAbsPath(config.crawl.root, _path.default.dirname(absConfigPath)));
 /** Step (2) */
 
 const files = (0, _parse.processFiles)(inputFiles, config, f => {
   const resolvedPath = (0, _utils.getPathWithExtension)(f, config);
-
   if (!resolvedPath) {
     throw new Error(`Unable to find ${f}`);
   }
-
+  if (!(0, _fs.existsSync)(resolvedPath)) {
+    return null;
+  }
   return {
     text: (0, _fs.readFileSync)(resolvedPath, "utf8"),
     resolvedPath
@@ -85,7 +55,6 @@ const files = (0, _parse.processFiles)(inputFiles, config, f => {
 let filesHadErrors = false;
 Object.keys(files).forEach(key => {
   const file = files[key];
-
   if (file.errors.length) {
     filesHadErrors = true;
     console.error(`Errors in ${file.path}`);
@@ -94,19 +63,17 @@ Object.keys(files).forEach(key => {
     });
   }
 });
-
 if (filesHadErrors) {
   console.error("Aborting");
   process.exit(1);
 }
-/** Step (3) */
 
+/** Step (3) */
 
 const {
   resolved,
   errors
 } = (0, _resolve.resolveDocuments)(files, config);
-
 if (errors.length) {
   errors.forEach(error => {
     console.error(`Resolution error ${error.message} in ${error.loc.path}`);
@@ -114,22 +81,20 @@ if (errors.length) {
   console.error("Aborting");
   process.exit(1);
 }
-
 console.log(Object.keys(resolved).length, "resolved queries");
+
 /** Step (4) */
 
 const schemaCache = {};
-
 const getCachedSchemas = schemaFilePath => {
   if (!schemaCache[schemaFilePath]) {
-    schemaCache[schemaFilePath] = (0, _config.getSchemas)(makeAbsPath(schemaFilePath, _path.default.dirname(absConfigPath)));
+    schemaCache[schemaFilePath] = (0, _config.getSchemas)((0, _config.makeAbsPath)(schemaFilePath, _path.default.dirname(options.configFilePath)));
   }
-
   return schemaCache[schemaFilePath];
 };
-
 let validationFailures = 0;
 const printedOperations = [];
+let outputFiles = {};
 Object.keys(resolved).forEach(filePathAndLine => {
   const {
     document,
@@ -139,35 +104,27 @@ Object.keys(resolved).forEach(filePathAndLine => {
     kind
   }) => kind !== "FragmentDefinition");
   const rawSource = raw.literals[0];
-  const generateConfig = (0, _config.findApplicableConfig)( // strip off the trailing line number, e.g. `:23`
+  const generateConfig = (0, _config.findApplicableConfig)(
+  // strip off the trailing line number, e.g. `:23`
   filePathAndLine.split(":")[0], config.generate);
-
   if (!generateConfig) {
     return; // no generate config matches, bail
   }
-
   const withTypeNames = (0, _apolloUtilities.addTypenameToDocument)(document);
   const printed = (0, _printer.print)(withTypeNames);
-
   if (hasNonFragments && !printedOperations.includes(printed)) {
     printedOperations.push(printed);
   }
-
   const pragmaResult = (0, _generateTypeFiles.processPragmas)(generateConfig, config.crawl, rawSource);
-
   if (!pragmaResult.generate) {
     return;
   }
-
   if (pragmaResult.strict != null) {
     generateConfig.strictNullability = pragmaResult.strict;
   }
-
   const [schemaForValidation, schemaForTypeGeneration] = getCachedSchemas(generateConfig.schemaFilePath);
-
   if (hasNonFragments) {
     const errors = (0, _validation.validate)(schemaForValidation, withTypeNames);
-
     if (errors.length) {
       errors.forEach(error => {
         console.error(`Schema validation found errors for ${raw.loc.path}!`);
@@ -177,9 +134,8 @@ Object.keys(resolved).forEach(filePathAndLine => {
       });
     }
   }
-
   try {
-    (0, _generateTypeFiles.generateTypeFiles)(raw.loc.path, schemaForTypeGeneration, withTypeNames, generateConfig);
+    outputFiles = (0, _generateTypeFiles.generateTypeFiles)(raw.loc.path, schemaForTypeGeneration, withTypeNames, generateConfig, outputFiles);
   } catch (err) {
     console.error(`Error while generating operation from ${raw.loc.path}`);
     console.error(printed);
@@ -188,11 +144,15 @@ Object.keys(resolved).forEach(filePathAndLine => {
   }
 });
 
+/** Step (5) */
+
+for (const [fname, content] of Object.entries(outputFiles)) {
+  (0, _fs.writeFileSync)(fname, content, "utf8");
+}
 if (validationFailures) {
   console.error(`Encountered ${validationFailures} validation failures while printing types.`);
   process.exit(1);
 }
-
 if (config.crawl.dumpOperations) {
   const dumpOperations = config.crawl.dumpOperations;
   const parent = (0, _path.dirname)(dumpOperations);

package/dist/enums.js

@@ -4,44 +4,34 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.scalarTypeToFlow = exports.experimentalEnumTypeToFlow = exports.enumTypeToFlow = exports.builtinScalars = void 0;
-
 var babelTypes = _interopRequireWildcard(require("@babel/types"));
-
 var _utils = require("./utils");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /**
  * Both input & output types can have enums & scalars.
  */
+
 const experimentalEnumTypeToFlow = (ctx, enumConfig, description) => {
-  const enumDeclaration = babelTypes.tsEnumDeclaration( // pass id into generic type annotation
+  const enumDeclaration = babelTypes.tsEnumDeclaration(
+  // pass id into generic type annotation
   babelTypes.identifier(enumConfig.name), enumConfig.enumValues.map(v => babelTypes.tsEnumMember(babelTypes.identifier(v.name), babelTypes.stringLiteral(v.name))));
-
   if (ctx.experimentalEnumsMap) {
     ctx.experimentalEnumsMap[enumConfig.name] = enumDeclaration;
   }
-
-  return (0, _utils.maybeAddDescriptionComment)(description, babelTypes.tsTypeReference(enumDeclaration.id));
+  return (0, _utils.maybeAddDescriptionComment)(ctx.noComments ? null : description, babelTypes.tsTypeReference(enumDeclaration.id));
 };
-
 exports.experimentalEnumTypeToFlow = experimentalEnumTypeToFlow;
-
 const enumTypeToFlow = (ctx, name) => {
   const enumConfig = ctx.schema.enumsByName[name];
   let combinedDescription = enumConfig.enumValues.map(n => `- ${n.name}` + (n.description ? "\n\n      " + n.description.replace(/\n/g, "\n      ") : "")).join("\n");
-
   if (enumConfig.description) {
     combinedDescription = enumConfig.description + "\n\n" + combinedDescription;
   }
-
-  return ctx.experimentalEnumsMap ? experimentalEnumTypeToFlow(ctx, enumConfig, combinedDescription) : (0, _utils.maybeAddDescriptionComment)(combinedDescription, babelTypes.tsUnionType(enumConfig.enumValues.map(n => babelTypes.tsLiteralType(babelTypes.stringLiteral(n.name)))));
+  return ctx.experimentalEnumsMap ? experimentalEnumTypeToFlow(ctx, enumConfig, combinedDescription) : (0, _utils.maybeAddDescriptionComment)(ctx.noComments ? null : combinedDescription, babelTypes.tsUnionType(enumConfig.enumValues.map(n => babelTypes.tsLiteralType(babelTypes.stringLiteral(n.name)))));
 };
-
 exports.enumTypeToFlow = enumTypeToFlow;
-const builtinScalars = {
+const builtinScalars = exports.builtinScalars = {
   Boolean: "boolean",
   String: "string",
   DateTime: "string",
@@ -50,21 +40,15 @@ const builtinScalars = {
   Int: "number",
   Float: "number"
 };
-exports.builtinScalars = builtinScalars;
-
 const scalarTypeToFlow = (ctx, name) => {
   if (builtinScalars[name]) {
     return babelTypes.tsTypeReference(babelTypes.identifier(builtinScalars[name]));
   }
-
   const underlyingType = ctx.scalars[name];
-
   if (underlyingType != null) {
     return babelTypes.tsTypeReference(babelTypes.identifier(underlyingType));
   }
-
   ctx.errors.push(`Unexpected scalar '${name}'! Please add it to the "scalars" argument at the callsite of 'generateFlowTypes()'.`);
   return babelTypes.tsTypeReference(babelTypes.identifier(`UNKNOWN_SCALAR["${name}"]`));
 };
-
 exports.scalarTypeToFlow = scalarTypeToFlow;