relay-compiler 11.0.2 → 13.0.0-rc.2

package/README.md

@@ -0,0 +1,108 @@
+# Relay Compiler
+
+Relay-Compiler is a code-generation toolkit for GraphQL. It contains the core
+functionalities of GraphQL code-gen, including file parsing, validation, syntax
+tree parsing and transformation.
+
+## Configuration in package.json
+
+The simplest way to configure relay is to add a new `relay` section to your
+`package.json` that contains the relay config.
+
+At minimum, the relay config must specify where to find source files (i.e. files
+containing `graphql` literals) and the GraphQL schema for the project.
+
+```
+// adding new section to package json
+{
+  ...
+ "scripts": {
+    "relay": "relay-compiler"
+ },
+ ...
+ // relay configuration
+ "relay": {
+    "src": "./src",
+    "schema": "./src/schema/app_schema.graphql"
+  }
+}
+```
+Relay Compiler will automatically discover the config if:
+
+- There is a `relay.config.json`, `relay.config.js` file at the root of the
+project (i.e. in the same folder as the `package.json` file).
+- The `package.json` file contains a `"relay"` key.
+
+Additionally, this config file can be specified with the CLI argument `--config`
+as follows:
+
+```shell
+npm run relay --config ./relay.json
+```
+
+or with yarn
+
+```shell
+yarn relay --config ./relay.json
+```
+
+Please note, that if you pass configuration options via --cli arguments, you'll
+need to provide a separate configuration for the [babel plugin](https://www.npmjs.com/package/babel-plugin-relay).
+
+## File Finder
+Relay compiler uses [`watchman`](https://facebook.github.io/watchman/) to find
+file sources, and "listen" to the file  changes in the "watch" mode.
+If `watchman` is not available, the compiler will
+use [glob](https://docs.rs/glob/latest/glob/) to query the filesystem for files.
+
+## Configuration
+
+### Supported compiler configuration options
+
+- `src`                 Root directory of application code.  [string] [required]
+- `schema`              Relative path to the file with GraphQL SDL file.
+                                                             [string] [required]
+- `artifactDirectory`   A specific directory to output all artifacts to. When
+                        enabling this the babel plugin needs `artifactDirectory`
+                        to be set as well.                              [string]
+- `language`            The name of the language used for input files and
+                        generated artifacts.
+                                       ["flow" | "typescript"] [default: "flow"]
+- `excludes`            Directories to ignore under `src`.     [array] [default:
+               ["**/node_modules/**", "**/__mocks__/**", "**/__generated__/**"]]
+- `schemaExtensions`    List of directories with schema extensions.      [array]
+- `noFutureProofEnums`  For `flow` only. This option controls whether or not
+                        a catch-all entry is added to enum type definitions
+                        values that may be added in the future. Enabling this
+                        means you will have to update your application whenever
+                        the GraphQL server schema adds new enum values to
+                        prevent it from breaking.      [boolean][default: false]
+- `customScalars`       Mappings from custom scalars in your schema to built-in
+                        GraphQL types, for type emission purposes.      [object]
+- `eagerEsModules`      This option enables emitting ES modules artifacts.
+                                                       [boolean][default: false]
+- `persistConfig`
+  - `url`               String, URL to send a POST request to to persist.
+                                                                        [string]
+  - `params`            The document will be in a `POST`
+                        parameter `text`. This map can contain additional
+                        parameters to send.                             [object]
+- `codegenCommand`      Command name that for relay compiler.           [string]
+
+- `isDevVariableName`   Name of the global variable for dev mode (`__DEV__`).
+                                                                        [string]
+- `jsModuleFormat`      Formatting style for generated files. `commonjs`
+                        or `haste`. Default is `commonjs`.
+                                                                        [string]
+
+
+### CLI configuration
+
+We also support a limited set of CLI arguments that should cover the most cases
+when you need to run the compiler.
+
+- `--src`               Relative path to the source code.
+- `--schema`            Relative path to schema file.
+- `--artifactDirectory` Compiler output directory.
+- `--watch`             Run compiler in `watch` mode
+(requires [`watchman`](https://facebook.github.io/watchman/) to be installed).

package/cli.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @noflow
+ * @format
+ */
+
+'use strict';
+
+var bin = require('./');
+var spawn = require('child_process').spawn;
+
+var input = process.argv.slice(2);
+
+if (bin !== null) {
+  spawn(bin, input, {stdio: 'inherit'}).on('exit', process.exit);
+} else {
+  throw new Error('Platform not supported.');
+}

package/index.js

@@ -1,10 +1,28 @@
 /**
- * Relay v11.0.2
- *
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
+ *
+ * @noflow
+ * @format
  */
 
-module.exports = require('./lib/index.js');
+'use strict';
+
+const path = require('path');
+
+let binary;
+if (process.platform === 'darwin' && process.arch === 'x64') {
+  binary = path.join(__dirname, 'macos-x64', 'relay');
+} else if (process.platform === 'darwin' && process.arch === 'arm64') {
+  binary = path.join(__dirname, 'macos-arm64', 'relay');
+} else if (process.platform === 'linux' && process.arch === 'x64') {
+  binary = path.join(__dirname, 'linux-x64', 'relay');
+} else if (process.platform === 'win32' && process.arch === 'x64') {
+  binary = path.join(__dirname, 'win-x64', 'relay.exe');
+} else {
+  binary = null;
+}
+
+module.exports = binary;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-compiler",
   "description": "A compiler tool for building GraphQL-driven applications.",
-  "version": "11.0.2",
+  "version": "13.0.0-rc.2",
   "keywords": [
     "graphql",
     "relay"
@@ -11,29 +11,5 @@
   "bugs": "https://github.com/facebook/relay/issues",
   "repository": "facebook/relay",
   "main": "index.js",
-  "bin": {
-    "relay-compiler": "bin/relay-compiler"
-  },
-  "dependencies": {
-    "@babel/core": "^7.0.0",
-    "@babel/generator": "^7.5.0",
-    "@babel/parser": "^7.0.0",
-    "@babel/runtime": "^7.0.0",
-    "@babel/traverse": "^7.0.0",
-    "@babel/types": "^7.0.0",
-    "babel-preset-fbjs": "^3.3.0",
-    "chalk": "^4.0.0",
-    "fb-watchman": "^2.0.0",
-    "fbjs": "^3.0.0",
-    "glob": "^7.1.1",
-    "immutable": "~3.7.6",
-    "invariant": "^2.2.4",
-    "nullthrows": "^1.1.1",
-    "relay-runtime": "11.0.2",
-    "signedsource": "^1.0.0",
-    "yargs": "^15.3.1"
-  },
-  "peerDependencies": {
-    "graphql": "^15.0.0"
-  }
+  "bin": "cli.js"
 }

package/bin/RelayCompilerBin.js.flow

@@ -1,169 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow
- * @format
- */
-
-// flowlint ambiguous-object-type:error
-
-'use strict';
-
-const _yargs = require('yargs');
-
-const {main} = require('./RelayCompilerMain');
-
-import type {Config} from './RelayCompilerMain';
-
-let RelayConfig;
-try {
-  // eslint-disable-next-line no-eval
-  RelayConfig = eval('require')('relay-config');
-  // eslint-disable-next-line lint/no-unused-catch-bindings
-} catch (_) {}
-
-const options = {
-  schema: {
-    describe: 'Path to schema.graphql or schema.json',
-    demandOption: true,
-    type: 'string',
-    array: false,
-  },
-  src: {
-    describe: 'Root directory of application code',
-    demandOption: true,
-    type: 'string',
-    array: false,
-  },
-  include: {
-    describe: 'Directories to include under src',
-    type: 'string',
-    array: true,
-    default: ['**'],
-  },
-  exclude: {
-    describe: 'Directories to ignore under src',
-    type: 'string',
-    array: true,
-    default: ['**/node_modules/**', '**/__mocks__/**', '**/__generated__/**'],
-  },
-  extensions: {
-    array: true,
-    describe:
-      'File extensions to compile (defaults to extensions provided by the ' +
-      'language plugin)',
-    type: 'string',
-  },
-  verbose: {
-    describe: 'More verbose logging',
-    type: 'boolean',
-    default: false,
-  },
-  quiet: {
-    describe: 'No output to stdout',
-    type: 'boolean',
-    default: false,
-  },
-  watchman: {
-    describe: 'Use watchman when not in watch mode',
-    type: 'boolean',
-    default: true,
-  },
-  watch: {
-    describe: 'If specified, watches files and regenerates on changes',
-    type: 'boolean',
-    default: false,
-  },
-  validate: {
-    describe:
-      'Looks for pending changes and exits with non-zero code instead of ' +
-      'writing to disk',
-    type: 'boolean',
-    default: false,
-  },
-  persistFunction: {
-    describe:
-      'An async function (or path to a module exporting this function) which will persist the query text and return the id.',
-    demandOption: false,
-    type: 'string',
-    array: false,
-  },
-  persistOutput: {
-    describe:
-      'A path to a .json file where persisted query metadata should be saved. Will use the default implementation (md5 hash) if `persistFunction` is not passed.',
-    demandOption: false,
-    type: 'string',
-    array: false,
-  },
-  repersist: {
-    describe: 'Run the persist function even if the query has not changed.',
-    type: 'boolean',
-    default: false,
-  },
-  noFutureProofEnums: {
-    describe:
-      'This option controls whether or not a catch-all entry is added to enum type definitions ' +
-      'for values that may be added in the future. Enabling this means you will have to update ' +
-      'your application whenever the GraphQL server schema adds new enum values to prevent it ' +
-      'from breaking.',
-    type: 'boolean',
-    default: false,
-  },
-  language: {
-    describe:
-      'The name of the language plugin used for input files and artifacts',
-    demandOption: false,
-    type: 'string',
-    array: false,
-    default: 'javascript',
-  },
-  artifactDirectory: {
-    describe:
-      'A specific directory to output all artifacts to. When enabling this ' +
-      'the babel plugin needs `artifactDirectory` set as well.',
-    demandOption: false,
-    type: 'string',
-    array: false,
-  },
-  customScalars: {
-    describe:
-      'Mappings from custom scalars in your schema to built-in GraphQL ' +
-      'types, for type emission purposes. (Uses yargs dot-notation, e.g. ' +
-      '--customScalars.URL=String)',
-    type: ('object': $FlowFixMe),
-  },
-  eagerESModules: {
-    describe: 'This option enables emitting es modules artifacts.',
-    type: 'boolean',
-    default: false,
-  },
-};
-
-// Parse CLI args
-let yargs = _yargs
-  .usage(
-    'Create Relay generated files\n\n' +
-      '$0 --schema <path> --src <path> [--watch]',
-  )
-  .options(options)
-  .strict();
-
-// Load external config
-const config = RelayConfig && RelayConfig.loadConfig();
-if (config) {
-  // Apply externally loaded config through the yargs API so that we can leverage yargs' defaults and have them show up
-  // in the help banner. We add it conditionally otherwise yargs would add new option `--config` which is confusing for
-  // Relay users (it's not Relay Config file).
-  yargs = yargs.config(config);
-}
-
-const argv: Config = (yargs.help().argv: $FlowFixMe);
-
-// Start the application
-main(argv).catch(error => {
-  console.error(String(error.stack || error));
-  process.exit(1);
-});