Skip to content

Commit 2f1453d

Browse files
committed
chore(*): Linting
1 parent 839bf36 commit 2f1453d

19 files changed

Lines changed: 70 additions & 51 deletions

.prettierignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
CHANGELOG.md
2+
coverage
3+
dist
4+
docs
5+
node_modules

package.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,14 @@
100100
}
101101
},
102102
"eslintConfig": {
103-
"extends": "@stencila/eslint-config"
103+
"extends": "@stencila/eslint-config",
104+
"rules": {
105+
"@typescript-eslint/prefer-regexp-exec": 1,
106+
"@typescript-eslint/require-await": 1,
107+
"@typescript-eslint/restrict-plus-operands": 1,
108+
"@typescript-eslint/strict-boolean-expressions": 1,
109+
"@typescript-eslint/unbound-method": 1
110+
}
104111
},
105112
"husky": {
106113
"hooks": {

src/CachingUrlFetcher.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import IUrlFetcher from './IUrlFetcher'
1+
import UrlFetcher from './IUrlFetcher'
22

33
import { NetworkError } from './errors'
44
import persist from 'node-persist'
@@ -10,7 +10,7 @@ let REQUEST_CACHE_INITIALISED = false
1010
/**
1111
* The default URL fetcher that Dockta uses. Fetches using `got` and caches results using `persist`
1212
*/
13-
export default class CachingUrlFetcher implements IUrlFetcher {
13+
export default class CachingUrlFetcher implements UrlFetcher {
1414
/**
1515
* Fetch a URL using `got`, attempting to retrieve it from cache first.
1616
*/

src/DockerBuilder.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ export default class DockerBuilder {
211211
break
212212

213213
case 'COPY':
214-
case 'ADD':
214+
case 'ADD': {
215215
// Add files/subdirs to the container
216216
const copy = instruction.args as Array<string>
217217
const to = copy.pop() as string
@@ -229,8 +229,8 @@ export default class DockerBuilder {
229229
})
230230
await container.putArchive(pack, { path: workdir })
231231
break
232-
233-
case 'RUN':
232+
}
233+
case 'RUN': {
234234
// Execute code in the container
235235
const script = instruction.args as string
236236
const exec = await container.exec({
@@ -251,7 +251,7 @@ export default class DockerBuilder {
251251
await new Promise(resolve => setTimeout(resolve, 100))
252252
}
253253
break
254-
254+
}
255255
case 'CMD':
256256
// Dockerfile instructions to apply when committing the image
257257
changes += instruction.raw + '\n\n'

src/DockerCompiler.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import parsers from './parsers'
88
import DockerGenerator from './DockerGenerator'
99
import DockerBuilder from './DockerBuilder'
1010
import DockerExecutor from './DockerExecutor'
11-
import IUrlFetcher from './IUrlFetcher'
11+
import UrlFetcher from './IUrlFetcher'
1212

1313
/**
1414
* Compiles a project into a Dockerfile, or Docker image
@@ -17,9 +17,9 @@ export default class DockerCompiler {
1717
/**
1818
* The instance of IUrlFetcher to fetch URLs
1919
*/
20-
private readonly urlFetcher: IUrlFetcher
20+
private readonly urlFetcher: UrlFetcher
2121

22-
constructor(urlFetcher: IUrlFetcher) {
22+
constructor(urlFetcher: UrlFetcher) {
2323
this.urlFetcher = urlFetcher
2424
}
2525

src/DockerExecutor.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export default class DockerExecutor {
6262
// CMD in the Dockerfile
6363
let cmd
6464
if (command) cmd = command.split(' ')
65-
const container = await docker.run(name, [], [stdout, stderr], {
65+
await docker.run(name, [], [stdout, stderr], {
6666
Cmd: cmd,
6767
HostConfig: {
6868
Binds: [`${path.resolve(folder)}:/work`]
@@ -71,7 +71,6 @@ export default class DockerExecutor {
7171
User: user,
7272
WorkingDir: '/work'
7373
})
74-
container.remove()
7574

7675
// Attempt to parse output as JSON
7776
try {

src/DockerGenerator.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { SoftwareEnvironment } from '@stencila/schema'
22

33
import Generator from './Generator'
44
import generators from './generators'
5-
import IUrlFetcher from './IUrlFetcher'
5+
import UrlFetcher from './IUrlFetcher'
66

77
const PREFERRED_UBUNTU_VERSION = '18.10'
88

@@ -61,7 +61,7 @@ export default class DockerGenerator extends Generator {
6161
protected generators: Array<Generator>
6262

6363
constructor(
64-
urlFetcher: IUrlFetcher,
64+
urlFetcher: UrlFetcher,
6565
environ: SoftwareEnvironment,
6666
folder?: string,
6767
baseImage?: string

src/Doer.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import path from 'path'
44
import tmp from 'tmp'
55

66
import { PermissionError } from './errors'
7-
import IUrlFetcher from './IUrlFetcher'
7+
import UrlFetcher from './IUrlFetcher'
88

99
/**
1010
* A utility base class for the `Parser` and `Generator` classes
@@ -19,9 +19,9 @@ export default abstract class Doer {
1919
/**
2020
* The instance of IUrlFetcher to fetch URLs
2121
*/
22-
protected readonly urlFetcher: IUrlFetcher
22+
protected readonly urlFetcher: UrlFetcher
2323

24-
constructor(urlFetcher: IUrlFetcher, folder: string | undefined) {
24+
constructor(urlFetcher: UrlFetcher, folder: string | undefined) {
2525
if (!folder) folder = tmp.dirSync().name
2626
this.folder = folder
2727
this.urlFetcher = urlFetcher

src/Generator.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import Doer from './Doer'
2-
import IUrlFetcher from './IUrlFetcher'
2+
import UrlFetcher from './IUrlFetcher'
33

44
const VERSION = require('../package').version
55
const DOCKER_USER = 'guest'
@@ -14,7 +14,7 @@ export default class Generator extends Doer {
1414
baseImage?: string
1515

1616
constructor(
17-
urlFetcher: IUrlFetcher,
17+
urlFetcher: UrlFetcher,
1818
folder: string | undefined,
1919
baseImage?: string
2020
) {

src/IUrlFetcher.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* Standard interface that can be used for fetching URLs
33
*/
4-
export default interface IUrlFetcher {
4+
export default interface UrlFetcher {
55
/**
66
* Fetch a URL
77
*

0 commit comments

Comments
 (0)