added docs fixed line length bug

added formatting options to docs
fixd line length bug where 0 was ignored because it is falsy
#39

Author: paustint

docs/package-lock.json

@@ -13,7 +13,7 @@
     "react-dom": "^16.5.2",
     "react-scripts-ts": "3.1.0",
     "react-syntax-highlighter": "^9.0.0",
-    "soql-parser-js": "^0.7.0"
+    "soql-parser-js": "^0.8.0"
   },
   "scripts": {
     "start": "react-scripts-ts start",

docs/package.json

@@ -3,7 +3,7 @@ import { TextField } from 'office-ui-fabric-react/lib/TextField';
 import { Checkbox } from 'office-ui-fabric-react/lib/Checkbox';
 import * as React from 'react';
 import * as CopyToClipboard from 'react-copy-to-clipboard';
-import { parseQuery, Query, composeQuery, isQueryValid } from 'soql-parser-js';
+import { parseQuery, Query, composeQuery, isQueryValid, FormatOptions } from 'soql-parser-js';
 import SyntaxHighlighter from 'react-syntax-highlighter/prism';
 import { xonokai } from 'react-syntax-highlighter/styles/prism';
 
@@ -19,6 +19,7 @@ interface IParseSoqlState {
   composedQuery?: string;
   soql: string;
   format: boolean;
+  formatOptions: FormatOptions;
 }
 
 export class ParseSoql extends React.Component<IParseSoqlProps, IParseSoqlState> {
@@ -34,6 +35,11 @@ export class ParseSoql extends React.Component<IParseSoqlProps, IParseSoqlState>
       composedQuery,
       soql: props.soql || '',
       format: true,
+      formatOptions: {
+        fieldMaxLineLen: 60,
+        fieldSubqueryParensOnOwnLine: true,
+        whereClauseOperatorsIndented: false,
+      },
     };
   }
 
@@ -61,11 +67,11 @@ export class ParseSoql extends React.Component<IParseSoqlProps, IParseSoqlState>
     }
   };
 
-  public parseQuery = (query?: string, format?: boolean) => {
+  public parseQuery = (query?: string, format?: boolean, formatOptions?: FormatOptions) => {
     try {
       format = typeof format === 'boolean' ? format : this.state.format;
       const parsedSoql: Query = parseQuery(query || this.state.soql);
-      const composedQuery: string = composeQuery(parsedSoql, { format });
+      const composedQuery: string = composeQuery(parsedSoql, { format, formatOptions });
       this.setState({
         parsedSoql: JSON.stringify(parsedSoql, null, 4),
         composedQuery,
@@ -85,7 +91,34 @@ export class ParseSoql extends React.Component<IParseSoqlProps, IParseSoqlState>
 
   public toggleFormat = () => {
     this.setState({ format: !this.state.format });
-    this.parseQuery(this.state.soql, !this.state.format);
+    this.parseQuery(this.state.soql, !this.state.format, this.state.formatOptions);
+  };
+
+  public toggleSubqueryParens = () => {
+    const formatOptions = {
+      ...this.state.formatOptions,
+      fieldSubqueryParensOnOwnLine: !this.state.formatOptions.fieldSubqueryParensOnOwnLine,
+    };
+    this.setState({ formatOptions });
+    this.parseQuery(this.state.soql, this.state.format, formatOptions);
+  };
+
+  public toggleWhereClauseIndent = () => {
+    const formatOptions = {
+      ...this.state.formatOptions,
+      whereClauseOperatorsIndented: !this.state.formatOptions.whereClauseOperatorsIndented,
+    };
+    this.setState({ formatOptions });
+    this.parseQuery(this.state.soql, this.state.format, formatOptions);
+  };
+
+  public setMaxFieldLen = (ev: React.SyntheticEvent<HTMLInputElement>) => {
+    const formatOptions = {
+      ...this.state.formatOptions,
+      fieldMaxLineLen: Math.max(0, Number((ev.target as HTMLInputElement).value)),
+    };
+    this.setState({ formatOptions });
+    this.parseQuery(this.state.soql, this.state.format, formatOptions);
   };
 
   public render() {
@@ -156,6 +189,33 @@ export class ParseSoql extends React.Component<IParseSoqlProps, IParseSoqlState>
                 </SyntaxHighlighter>
                 <div style={{ margin: 5 }}>
                   <Checkbox label="Format Output" checked={this.state.format} onChange={this.toggleFormat} />
+                  <div style={{ margin: 5, paddingLeft: 10 }}>
+                    <div style={{ maxWidth: 250 }}>
+                      <TextField
+                        label="Number of characters before fields wrap"
+                        type="number"
+                        value={String(this.state.formatOptions.fieldMaxLineLen)}
+                        onChange={this.setMaxFieldLen}
+                        disabled={!this.state.format}
+                      />
+                    </div>
+                    <div style={{ marginTop: 5 }}>
+                      <Checkbox
+                        label="Subquery Parenthesis on own line"
+                        checked={this.state.formatOptions.fieldSubqueryParensOnOwnLine}
+                        onChange={this.toggleSubqueryParens}
+                        disabled={!this.state.format}
+                      />
+                    </div>
+                    <div style={{ marginTop: 5 }}>
+                      <Checkbox
+                        label="Indent items in WHERE clause"
+                        checked={this.state.formatOptions.whereClauseOperatorsIndented}
+                        onChange={this.toggleWhereClauseIndent}
+                        disabled={!this.state.format}
+                      />
+                    </div>
+                  </div>
                 </div>
                 <CopyToClipboard text={this.state.composedQuery}>
                   <Button

docs/src/components/parse-soql.tsx

@@ -182,6 +182,11 @@ export default class SampleQueries extends React.Component<ISampleQueriesProps,
         num: 43,
         soql: `SELECT Id, Name FROM Account WHERE Id IN (SELECT AccountId FROM Contact WHERE LastName LIKE 'apple%') AND Id IN (SELECT AccountId FROM Opportunity WHERE isClosed = false)`,
       },
+      {
+        key: 44,
+        num: 44,
+        soql: `SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy, ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type, Website, (SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate, CreatedById, Type FROM Opportunities), (SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, Website FROM ChildAccounts) FROM Account WHERE Name LIKE 'a%' OR Name LIKE 'b%' OR Name LIKE 'c%'`,
+      },
     ];
   };
 

docs/src/components/sample-queries.tsx

@@ -1,5 +1,6 @@
 import { composeQuery } from './SoqlComposer';
 import { parseQuery } from './SoqlParser';
+import { isNumber } from './utils';
 
 export interface FieldData {
   fields: {
@@ -85,7 +86,7 @@ export class Formatter {
           field.suffix = fieldData.fields.length - 1 === i ? '' : ', ';
           lineLen = 0;
           newLineAndIndentNext = true;
-        } else if (this.options.fieldMaxLineLen) {
+        } else if (isNumber(this.options.fieldMaxLineLen)) {
           // If max line length is specified, create a new line when needed
           // Add two to account for ", "
           lineLen += field.text.length + field.suffix.length;

lib/SoqlFormatter.ts

@@ -248,6 +248,57 @@ AND Id IN (SELECT AccountId
 \tFROM Opportunity
 \tWHERE isClosed = false)
 ORDER BY GROUPING(Type), GROUPING(Id, BillingCountry), Name DESC NULLS FIRST, Id ASC NULLS LAST    
+`.trim(),
+  },
+  {
+    testCase: 11,
+    soql: `SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy, ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type, Website, (SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate, CreatedById, Type FROM Opportunities), (SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, Website FROM ChildAccounts) FROM Account WHERE Name LIKE 'a%' OR Name LIKE 'b%' OR Name LIKE 'c%'`,
+    formatOptions: { fieldMaxLineLen: 0, fieldSubqueryParensOnOwnLine: true, whereClauseOperatorsIndented: false },
+    formattedSoql: `SELECT 
+\tId,
+\tName,
+\tAccountNumber,
+\tAccountSource,
+\tAnnualRevenue,
+\tBillingAddress,
+\tBillingCity,
+\tBillingCountry,
+\tBillingGeocodeAccuracy,
+\tShippingStreet,
+\tSic,
+\tSicDesc,
+\tSite,
+\tSystemModstamp,
+\tTickerSymbol,
+\tType,
+\tWebsite,
+\t(
+\t\tSELECT 
+\t\t\tId,
+\t\t\tName,
+\t\t\tAccountId,
+\t\t\tAmount,
+\t\t\tCampaignId,
+\t\t\tCloseDate,
+\t\t\tCreatedById,
+\t\t\tType
+\t\tFROM Opportunities
+\t),
+\t(
+\t\tSELECT 
+\t\t\tId,
+\t\t\tName,
+\t\t\tAccountNumber,
+\t\t\tAccountSource,
+\t\t\tAnnualRevenue,
+\t\t\tBillingAddress,
+\t\t\tWebsite
+\t\tFROM ChildAccounts
+\t)
+FROM Account
+WHERE Name LIKE 'a%'
+OR Name LIKE 'b%'
+OR Name LIKE 'c%'
 `.trim(),
   },
 ];