Ensure CI runs lint and tests (#684)

.buildkite/lint.sh

@@ -4,4 +4,6 @@ set -ex
 cd "$(dirname "${BASH_SOURCE[0]}")/.."
 
 yarn --mutex network --frozen-lockfile --network-timeout 60000
-yarn run build eslint prettier-check
+yarn run build
+yarn run eslint
+yarn run prettier-check

.buildkite/test.sh

@@ -4,4 +4,6 @@ set -ex
 cd "$(dirname "${BASH_SOURCE[0]}")/.."
 
 yarn --mutex network --frozen-lockfile --network-timeout 60000
-yarn run build test coverage
+yarn run build
+yarn run test
+yarn run coverage

.eslintrc.js

@@ -5,12 +5,12 @@ module.exports = {
     node: true,
   },
   parserOptions: {
-    project: ['template/tsconfig.json', 'dev/scripts/tsconfig.json'],
+    project: ['template/tsconfig.json', 'scripts/tsconfig.json'],
   },
-  ignorePatterns: ['generated-*', '**/dist', 'samples'],
+  ignorePatterns: ['generated-*', '**/dist'],
   rules: {
     // [...a] breaks when Array.from(a) works
     // when a is not an array but an iterable
-    "unicorn/prefer-spread": 0
+    'unicorn/prefer-spread': 0,
   },
 }

.gitignore

@@ -1,9 +1,9 @@
-generated-*
-temp
+.cache
+.nyc_output
+coverage
 dist
+generated-*
 node_modules
-coverage
-.cache
-.nyc_output/
+
 .eslintcache
 yarn-error.log

.prettierignore

@@ -1,8 +1,6 @@
-generated-*
-temp
-dist
-node_modules
-coverage
 .cache
-samples
 .nyc_output
+coverage
+dist
+generated-*
+node_modules

scripts/args.ts

@@ -1,4 +1,5 @@
 import yargs from 'yargs'
+
 import { languageSpecs } from '../template/src/language-specs/languages'
 import { LanguageSpec } from '../template/src/language-specs/spec'
 

scripts/generate.ts

@@ -1,7 +1,10 @@
+import * as path from 'path'
+
 import { copy, emptyDir, ensureDir } from 'fs-extra'
 import * as fs from 'mz/fs'
-import * as path from 'path'
+
 import { LanguageSpec } from '../template/src/language-specs/spec'
+
 import { findLanguageSpecs } from './args'
 
 async function main(): Promise<void> {
@@ -46,7 +49,9 @@ async function generate({ languageID, stylized }: LanguageSpec): Promise<void> {
     // Update README.md placeholders with language name
     await fs.writeFile(
         readmeFilename,
-        (await fs.readFile(readmeFilename))
+        (
+            await fs.readFile(readmeFilename)
+        )
             .toString()
             .replace(/LANG\b/g, stylized)
             .replace(/LANGID\b/g, languageID)

scripts/publish.ts

@@ -1,5 +1,6 @@
 import * as child_process from 'mz/child_process'
 import * as fs from 'mz/fs'
+
 import { findLanguageSpecs } from './args'
 
 async function main(): Promise<void> {

scripts/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.json",
+}

template/src/extension.ts

@@ -1,16 +1,17 @@
-import * as sourcegraph from 'sourcegraph'
-import { languageSpecs } from './language-specs/languages'
-import { languageID } from './language'
 import { from } from 'rxjs'
 import { distinctUntilChanged, map, startWith } from 'rxjs/operators'
+import * as sourcegraph from 'sourcegraph'
+
+import { languageID } from './language'
+import { languageSpecs } from './language-specs/languages'
 import { LanguageSpec } from './language-specs/spec'
 import { Logger, RedactingLogger } from './logging'
 import { createProviders } from './providers'
 
 /**
  * Register providers on the extension host.
  *
- * @param ctx The extension context.
+ * @param context The extension context.
  */
 export const activate = (context: sourcegraph.ExtensionContext): void => {
     for (const spec of languageID === 'all'
@@ -39,7 +40,7 @@ const DUMMY_CTX = {
  * Activate the extension by registering definition, reference, and hover providers
  * with LSIF and search-based providers.
  *
- * @param ctx  The extension context.
+ * @param context  The extension context.
  * @param selector The document selector for which this extension is active.
  * @param languageSpec The language spec used to provide search-based code intelligence.
  * @param logger An optional logger instance.

template/src/init.test.ts

@@ -1,4 +1,6 @@
+import mock from 'mock-require'
+
 // Stub Sourcegraph API
 import { createStubSourcegraphAPI } from '@sourcegraph/extension-api-stubs'
-import mock from 'mock-require'
+
 mock('sourcegraph', createStubSourcegraphAPI())

template/src/language-specs/cpp.test.ts

@@ -1,4 +1,5 @@
 import * as assert from 'assert'
+
 import { cppSpec } from './cpp'
 import { nilFilterContext, nilResult } from './spec.test'
 

template/src/language-specs/go.test.ts

@@ -1,4 +1,5 @@
 import * as assert from 'assert'
+
 import { goSpec } from './go'
 import { nilFilterContext, nilResult } from './spec.test'
 

template/src/language-specs/go.ts

@@ -1,4 +1,5 @@
 import * as path from 'path'
+
 import { slashPattern } from './comments'
 import { FilterContext, LanguageSpec, Result, LSIFSupport } from './spec'
 import { extractFromLines, filterResults } from './util'

template/src/language-specs/icons.test.ts

@@ -1,6 +1,8 @@
 import * as assert from 'assert'
-import * as fs from 'mz/fs'
 import * as path from 'path'
+
+import * as fs from 'mz/fs'
+
 import { languageSpecs } from './languages'
 
 describe('all defined languages', () => {

template/src/language-specs/java.test.ts

@@ -1,4 +1,5 @@
 import * as assert from 'assert'
+
 import { javaSpec } from './java'
 import { nilFilterContext, nilResult } from './spec.test'
 

template/src/language-specs/java.ts

@@ -1,4 +1,5 @@
 import * as path from 'path'
+
 import { javaStyleComment } from './comments'
 import { FilterContext, LanguageSpec, Result, LSIFSupport } from './spec'
 import { extractFromLines, filterResultsByImports, slashToDot } from './util'

template/src/language-specs/python.test.ts

@@ -1,4 +1,5 @@
 import * as assert from 'assert'
+
 import { pythonSpec, relativeImportPath } from './python'
 import { nilFilterContext, nilResult } from './spec.test'
 
@@ -36,10 +37,10 @@ describe('pythonSpec', () => {
 
 describe('relativeImportPath', () => {
     it('converts relative import to path', () => {
-        assert.equal(relativeImportPath('a/b/c.py', 'foo'), undefined)
-        assert.equal(relativeImportPath('a/b/c.py', '.foo'), 'a/b/foo')
-        assert.equal(relativeImportPath('a/b/c.py', '.foo.bar'), 'a/b/foo/bar')
-        assert.equal(relativeImportPath('a/b/c.py', '..foo.bar'), 'a/foo/bar')
-        assert.equal(relativeImportPath('a/b/c.py', '....foo'), '../foo')
+        assert.strictEqual(relativeImportPath('a/b/c.py', 'foo'), undefined)
+        assert.strictEqual(relativeImportPath('a/b/c.py', '.foo'), 'a/b/foo')
+        assert.strictEqual(relativeImportPath('a/b/c.py', '.foo.bar'), 'a/b/foo/bar')
+        assert.strictEqual(relativeImportPath('a/b/c.py', '..foo.bar'), 'a/foo/bar')
+        assert.strictEqual(relativeImportPath('a/b/c.py', '....foo'), '../foo')
     })
 })

template/src/language-specs/python.ts

@@ -1,4 +1,5 @@
 import * as path from 'path'
+
 import { pythonStyleComment } from './comments'
 import { FilterContext, LanguageSpec, Result } from './spec'
 import { extractFromLines, filterResultsByImports, removeExtension } from './util'

template/src/language-specs/typescript.test.ts

@@ -1,4 +1,5 @@
 import * as assert from 'assert'
+
 import { nilFilterContext, nilResult } from './spec.test'
 import { typescriptSpec } from './typescript'
 

template/src/language-specs/typescript.ts

@@ -1,4 +1,5 @@
 import * as path from 'path'
+
 import { cStyleComment } from './comments'
 import { FilterContext, LanguageSpec, Result, LSIFSupport } from './spec'
 import { extractFromLines, filterResultsByImports, removeExtension } from './util'

template/src/language-specs/util.ts

@@ -1,4 +1,5 @@
 import { isDefined } from '../util/helpers'
+
 import { Result } from './spec'
 
 /**
@@ -32,7 +33,7 @@ export function extractFromLines(fileContent: string, ...patterns: RegExp[]): st
  *
  * @param results A list of results to filter.
  * @param importPaths A list of import paths.
- * @param fn The filter function.
+ * @param func The filter function.
  */
 export function filterResultsByImports<T extends Result>(
     results: T[],
@@ -47,7 +48,7 @@ export function filterResultsByImports<T extends Result>(
  * function returns the original input unchanged.
  *
  * @param results A list of results to filter.
- * @param fn The filter function.
+ * @param func The filter function.
  */
 export function filterResults<T extends Result>(results: T[], func: (result: T) => boolean): T[] {
     const filteredResults = results.filter(result => func(result))

template/src/lsif/definition-hover.test.ts

@@ -1,7 +1,10 @@
 import * as assert from 'assert'
+
 import * as sinon from 'sinon'
 import * as sourcegraph from 'sourcegraph'
+
 import { QueryGraphQLFn } from '../util/graphql'
+
 import { GenericLSIFResponse } from './api'
 import { definitionAndHoverForPosition, DefinitionAndHoverResponse } from './definition-hover'
 import { makeEnvelope, resource1, resource2, resource3, range1, range2, range3, document, position } from './util.test'

template/src/lsif/definition-hover.ts

@@ -1,9 +1,11 @@
 import * as sourcegraph from 'sourcegraph'
 import gql from 'tagged-template-noop'
+
+import { DefinitionAndHover } from '../providers'
 import { queryGraphQL as sgQueryGraphQL, QueryGraphQLFn } from '../util/graphql'
-import { LocationConnectionNode, nodeToLocation } from './locations'
+
 import { GenericLSIFResponse, queryLSIF } from './api'
-import { DefinitionAndHover } from '../providers'
+import { LocationConnectionNode, nodeToLocation } from './locations'
 
 export type DefinitionAndHoverResponse = Partial<DefinitionResponse> & HoverResponse
 
@@ -97,7 +99,8 @@ export async function definitionAndHoverForPosition(
  * Convert a GraphQL definition and hover response into an object consisting of a list of Sourcegraph
  * locations and a markdown-formatted hover object.
  *
- * @param lsifObj The resolved LSIF object.
+ * @param textDocument The current document.
+ * @param lsifObject The resolved LSIF object.
  */
 export function definitionAndHoverResponseToLocations(
     textDocument: sourcegraph.TextDocument,

template/src/lsif/highlights.test.ts

@@ -1,6 +1,7 @@
 import * as assert from 'assert'
-import { range1, range2, range3, range4, document } from './util.test'
+
 import { filterLocationsForDocumentHighlights } from './highlights'
+import { range1, range2, range3, range4, document } from './util.test'
 
 describe('filterLocationsForDocumentHighlights', () => {
     it('should filter out distinct paths', () => {

template/src/lsif/highlights.ts

@@ -1,4 +1,5 @@
 import * as sourcegraph from 'sourcegraph'
+
 import { isDefined } from '../util/helpers'
 
 export function filterLocationsForDocumentHighlights(

template/src/lsif/locations.test.ts

@@ -1,5 +1,7 @@
 import * as assert from 'assert'
+
 import * as sourcegraph from 'sourcegraph'
+
 import { nodeToLocation } from './locations'
 
 describe('nodeToLocation', () => {

template/src/lsif/locations.ts

@@ -1,4 +1,5 @@
 import * as sourcegraph from 'sourcegraph'
+
 import { parseGitURI } from '../util/uri'
 
 export interface LocationConnectionNode {
@@ -13,7 +14,7 @@ export interface LocationConnectionNode {
 /**
  * Convert a GraphQL location connection node into a Sourcegraph location.
  *
- * @param doc The current document.
+ * @param textDocument The current document.
  * @param node A location connection node.
  */
 export function nodeToLocation(

template/src/lsif/providers.test.ts

@@ -1,9 +1,13 @@
 import * as assert from 'assert'
+
 import * as sinon from 'sinon'
 import * as sourcegraph from 'sourcegraph'
+
 import { QueryGraphQLFn } from '../util/graphql'
-import { createGraphQLProviders as createProviders } from './providers'
+
 import { GenericLSIFResponse } from './api'
+import { DefinitionResponse, DefinitionAndHoverResponse } from './definition-hover'
+import { createGraphQLProviders as createProviders } from './providers'
 import { ReferencesResponse, MAX_REFERENCE_PAGE_REQUESTS } from './references'
 import {
     gatherValues,
@@ -21,7 +25,6 @@ import {
     document,
     position,
 } from './util.test'
-import { DefinitionResponse, DefinitionAndHoverResponse } from './definition-hover'
 
 describe('graphql providers', () => {
     describe('combined definition and hover provider', () => {
@@ -239,9 +242,9 @@ describe('graphql providers', () => {
                 [[location1], [location1, location2], [location1, location2, location3]]
             )
 
-            assert.equal(queryGraphQLFn.getCall(0).args[1]?.after, undefined)
-            assert.equal(queryGraphQLFn.getCall(1).args[1]?.after, 'page2')
-            assert.equal(queryGraphQLFn.getCall(2).args[1]?.after, 'page3')
+            assert.strictEqual(queryGraphQLFn.getCall(0).args[1]?.after, undefined)
+            assert.strictEqual(queryGraphQLFn.getCall(1).args[1]?.after, 'page2')
+            assert.strictEqual(queryGraphQLFn.getCall(2).args[1]?.after, 'page3')
         })
 
         it('should not page results indefinitely', async () => {
@@ -272,7 +275,7 @@ describe('graphql providers', () => {
                 values
             )
 
-            assert.equal(queryGraphQLFn.callCount, MAX_REFERENCE_PAGE_REQUESTS)
+            assert.strictEqual(queryGraphQLFn.callCount, MAX_REFERENCE_PAGE_REQUESTS)
         })
     })
 

template/src/lsif/providers.ts

@@ -1,13 +1,15 @@
 import * as sourcegraph from 'sourcegraph'
+
+import { Logger } from '../logging'
 import { noopProviders, CombinedProviders, DefinitionAndHover } from '../providers'
 import { queryGraphQL as sgQueryGraphQL, QueryGraphQLFn } from '../util/graphql'
 import { asyncGeneratorFromPromise, cachePromiseProvider } from '../util/ix'
-import { Logger } from '../logging'
-import { RangeWindowFactoryFn, makeRangeWindowFactory } from './ranges'
-import { referencesForPosition, referencePageForPosition } from './references'
-import { filterLocationsForDocumentHighlights } from './highlights'
 import { raceWithDelayOffset } from '../util/promise'
+
 import { definitionAndHoverForPosition, hoverPayloadToHover } from './definition-hover'
+import { filterLocationsForDocumentHighlights } from './highlights'
+import { RangeWindowFactoryFn, makeRangeWindowFactory } from './ranges'
+import { referencesForPosition, referencePageForPosition } from './references'
 
 /**
  * Creates providers powered by LSIF-based code intelligence. This particular