Skip to content

Refactor to use export map instead of paths in tests #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wooorm merged 1 commit into from
Jul 27, 2022
Merged

Refactor to use export map instead of paths in tests #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Use package exports in tests 
This closer resembles real world usage. It also tests that package
exports are properly configured.
  • Loading branch information
@remcohaszing
remcohaszing committed Jul 26, 2022
commit b0479a6dcbbc1f91f09a533d3d38a9780cd1acf0
2 changes: 1 addition & 1 deletion test/code-actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'remark',
Expand Down
2 changes: 1 addition & 1 deletion test/folder/remark-with-cwd.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'remark',
Expand Down
8 changes: 0 additions & 8 deletions test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import {spawn} from 'node:child_process'
import path from 'node:path'
import {URL, fileURLToPath} from 'node:url'
import test from 'tape'

import * as exports from 'unified-language-server'
import {
createProtocolConnection,
CodeActionRequest,
Expand All @@ -22,12 +20,6 @@ import {
ShowMessageRequest
} from 'vscode-languageserver-protocol/node.js'

test('exports', (t) => {
Copy link
Member

@ChristianMurphy ChristianMurphy Jul 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit cautious on removing tests.
There should still be export, even if they are partiallytested elsewhere?

Copy link
Member Author

@remcohaszing remcohaszing Jul 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit cautious on removing tests.

I think that’s a good quality. :)

IMHO this test is a bit superfluous. It literally asserts the export is a function. All other tests test the behaviour of this function (fully, not partially).

Still, if you have strong feelings about this, I can restore it.

Copy link
Member

@wooorm wooorm Jul 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that the reason for something like this in the tests was because there was an export that was no longer needed.

A better way to test the API surface, which somewhat makes sure that we don’t export things we don’t need, and we do not accidentally remove things that we do need, would be something along the lines of:

const api = await import('unified-language-server')
const keys = Object.keys(api).sort()
assert.deepEqual(keys, ['something', 'somethingElse'])

t.equal(typeof exports.createUnifiedLanguageServer, 'function')

t.end()
})

test('`initialize`', async (t) => {
const connection = startLanguageServer(t, 'remark.js')
const initializeResponse = await connection.sendRequest(
Expand Down
2 changes: 1 addition & 1 deletion test/missing-package-with-default.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {remark} from 'remark'
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'xxx-missing-yyy',
Expand Down
2 changes: 1 addition & 1 deletion test/missing-package.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'xxx-missing-yyy'
Expand Down
2 changes: 1 addition & 1 deletion test/remark-with-cwd.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'remark',
Expand Down
2 changes: 1 addition & 1 deletion test/remark-with-error.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'remark',
Expand Down
2 changes: 1 addition & 1 deletion test/remark-with-warnings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'remark',
Expand Down
2 changes: 1 addition & 1 deletion test/remark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {createUnifiedLanguageServer} from '../index.js'
import {createUnifiedLanguageServer} from 'unified-language-server'

createUnifiedLanguageServer({
processorName: 'remark',
Expand Down