dockerfile-language-service

Dockerfile Language Service

This is a language service for Dockerfiles written in TypeScript. If you are looking for an actual Dockerfile language server that can be used with editors that implement the language server protocol, please visit the rcjsuen/dockerfile-language-server-nodejs repository.

The purpose of this project is to provide an API for creating a feature-rich Dockerfile editor. While this language service implements requests from the language server protocol, they are exposed as regular JavaScript functions so you can use them in the browser if you wish. For a demonstration of this language service's capabilities with Microsoft's Monaco Editor, please click here.

To install this language service as a dependency into your project, you will need to have Node.js.

Supported features:

• code actions
• code completion
• definition
• diagnostics
• document highlight
• document links
• document symbols
• formatting
• hovers
• rename
• signature help

Development Instructions

If you wish to build and compile this language server, you must first install Node.js if you have not already done so. After you have installed Node.js and cloned the repository with Git, you may now proceed to build and compile the language server with the following commands:

npm install
npm run build
npm test

If you are planning to change the code, use npm run watch to get the TypeScript files transpiled on-the-fly as they are modified.

Installation Instructions

To add this language service into your project, you must add dockerfile-language-service as a dependency in your package.json file.

Browser Example

The /example/ folder includes an example for using this language service in a browser as a static HTML page with JavaScript. To build the example, please run the following commands from the root of the project:

npm install
cd example
npm install
npm run build

As the example naturally relies on the language service, it is necessary to invoke npm install on the root folder first before invoking npm install in the /example/ folder. Once npm run build has completed, you can open the /example/lib/index.html in a browser to test things out!

Known Issues

If a light bulb appears when your text cursor is over a problem, you cannot click on the light bulb to see the possible code actions available to you for fixing the problem. This issue is being tracked by Microsoft/monaco-editor#574. As a workaround, please place the cursor inside the range of the problem's squiggly lines and then hit Ctrl+. and select a code from action from the context menu that appears.

Changelog

[0.0.3] - 2018-04-14

Added

• updated Capabilities interface to support documentation formats for CompletionItems (#12)

interface Capabilities {
    /**
     * Capabilities related to completion requests.
     */
    completion?: {
        /**
         * Capabilities related to completion items.
         */
        completionItem?: {
            /**
             * Describes the supported content types that can be used
             * for a CompletionItem's documentation field.
             */
            documentationFormat?: MarkupKind[];
        }
    }
}

• allow documentation in CompletionItems to be provided in Markdown (#12)
• warn if hyphens are being parsed as a unit of time in HEALTHCHECK duration flags (rcjsuen/dockerfile-utils#24)
• warn if two or more decimals found in a unit of time in HEALTHCHECK duration flags (rcjsuen/dockerfile-utils#25)
• warn if two hyphens are found in HEALTHCHECK duration flags (rcjsuen/dockerfile-utils#26)
• warn if instruction is written in JSON form incorrectly with single quotes (rcjsuen/dockerfile-utils#28)

Fixed

• fix incorrect validation error if a COPY uses JSON arguments and its last string argument is correctly defined as a folder (rcjsuen/dockerfile-utils#29)
• fix incorrect validation error if an ADD uses JSON arguments and its last string argument is correctly defined as a folder (rcjsuen/dockerfile-utils#30)
• skip validation of content after a JSON's closing bracket (rcjsuen/dockerfile-utils#33)
• fix validation of number of arguments for ADD and COPY instructions written in JSON (rcjsuen/dockerfile-utils#34)