Merge pull request #5 from Shopify/support-url-positional-arg

Add support for positional URL argument

Author: swalkinshaw

src/help.js

@@ -1,12 +1,25 @@
 export default `
-usage: graphql-js-schema-fetch --url my-api.com [--method=POST] [--header="...", --header="..."]
+usage: graphql-js-schema-fetch [URL | --url] [--method=POST] [--header="...", --header="..."]
 
 Fetch the json representation of a GraphQL Schema from a live server.
 
-arguments:
+Arguments:
  --url               The URL where you GraphQL API resides.
  --method            The HTTP method to use during the fetch (default: 'POST')
  --header[,--header] Any headers to send along with the request. Specify this
                      option multiple times for multiple headers. (example:
                      --header "Authorization: Basic abc123" --header "X-Version: 1")
+
+Examples:
+  Fetch schema with default headers:
+    graphql-js-schema-fetch https://api.example.com > schema.json
+
+  Fetch schema with authorization header:
+    graphql-js-schema-fetch https://api.example.com \
+      --header "Authorization: Basic abc123" > schema.json
+
+  Fetch schema with multiple headers:
+    graphql-js-schema-fetch https://api.example.com \
+      --header "Authorization: Basic abc123" \
+      --header "X-Version: 1" > schema.json
 `;

src/parse-args.js

@@ -13,11 +13,12 @@ export default function parseArgs(rawArgs) {
     }
   });
 
-  if (args.help || !args.url) {
+  const url = args._[0] || args.url;
+
+  if (args.help || !url) {
     return {showHelp: true};
   }
 
-  const url = args.url;
   const method = args.method;
 
   const headers = [].concat(args.header).reduce((headerAcc, header) => {

test/index.js

@@ -39,4 +39,16 @@ suite('This will test arg parsing', () => {
     assert.deepEqual(args.headers.Accept, 'application/json');
     assert.deepEqual(args.headers['Content-Type'], 'application/json');
   });
+
+  test('it supports positional url argument', () => {
+    const args = parseArgs(['https://graphql.example.com']);
+
+    assert.deepEqual(args.url, 'https://graphql.example.com');
+  });
+
+  test('it supports named url argument', () => {
+    const args = parseArgs(['--url', 'https://graphql.example.com']);
+
+    assert.deepEqual(args.url, 'https://graphql.example.com');
+  });
 });