Skip to content

Latest commit

 

History

History
574 lines (505 loc) · 38.3 KB

CHANGELOG.md

File metadata and controls

574 lines (505 loc) · 38.3 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

Unreleased

Added

  • support preparing renames for here-documents (#129)
  • support preparing renames for a build stage referenced in a FROM (#126)

Fixed

  • stop resolving definitions to build stages after the selected line (#130)
  • build stage references in FROM instructions will now be highlighted (#128)
  • build stage references in FROM instructions will now be included in rename edits (#127)

0.14.0 - 2024-06-18

Added

  • support computing highlight ranges for heredocs (#121)

Fixed

0.13.0 - 2024-05-04

Added

0.12.0 - 2024-05-04

Added

  • support navigating the definitions of heredocs (#122)

Changed

  • altered the return type of setCapabilities(Capabilities) in DockerfileLanguageService
    • previously it was implicitly set as any but it has now been changed to void
    • the implementation never did return anything so this should hopefully not affect anyone using the library

0.11.0 - 2023-09-10

Added

Fixed

  • correct link range calculation if tag provided with a digest (#120)

0.10.2 - 2023-06-01

Fixed

  • ignore quotes in comments if it's within an embedded argument with CRLF used as a newline delimiter (#113)
  • prevent 0-length semantic tokens from being added (#114)
  • correct typo in the comment handling logic of semantic tokens with CRLF newlines (#116)
  • ignore escaped newlines when checking for strings in semantic tokens (#115)

0.10.1 - 2023-05-31

Fixed

  • ignore UTF-8 BOM when calculating completion items (#112)

0.10.0 - 2023-05-28

Added

Fixed

0.9.0 - 2022-05-04

Added

  • add support for validating the --link flag in COPY instructions (#103
  • add support for validating the --link flag in ADD instructions (rcjsuen/dockerfile-utils#109)

Fixed

  • semantic tokens will no longer have negative values if quoted string content is inside a variable (#104)

0.8.1 - 2022-01-22

Fixed

  • operator and modifier semantic token types no longer share the same number in the legend (#101)

0.8.0 - 2022-01-22

Added

  • variable semantic tokens are now split up into multiple tokens, offering a finer-grained view of what each part of it is for which should improve readability (#100)

Fixed

0.7.4 - 2021-12-11

Fixed

  • fix TypeError thrown when computing completion items for a COPY instruction with flags (#97)
  • fix TypeError thrown when computing completion items for an ADD instruction with flags (#98)
  • fix infinite loop in ADD and COPY instructions when calculating WORKDIR suggestions for a build stage that shares its name with the image (#99)
  • ignore heredoc content when formatting (rcjsuen/dockerfile-utils#105)

0.7.3 - 2021-10-20

Fixed

  • prevent infinite loop when calculating semantic tokens if an escape character is not followed by any actual content (#95)
  • prevent infinite loop when calculating semantic tokens if an escape character is embedded within a variable (#96)

0.7.2 - 2021-09-21

Fixed

  • prevent infinite loop when calculating semantic tokens for an instruction with a keyword that spans multiple lines (#94)
  • prevent merging of instructions if it contains an escape character and spans multiple lines (rcjsuen/dockerfile-utils#103)
  • ignore comments embedded in an instruction's keyword (rcjsuen/dockerfile-utils#104)

0.7.1 - 2021-09-19

Fixed

  • correct replacement text range calculation in completion items (#93)

0.7.0 - 2021-09-19

Added

Fixed

  • consider escaped words when calculating prefixes for code completion (#60)

0.6.0 - 2021-09-11

Changed

Fixed

  • prevent infinite loop when computing semantic tokens for a keyword with an escape character (#91)
  • fix incorrect merging of error ranges if escape character embedded in the keyword (rcjsuen/dockerfile-utils#99)
  • fix undefined hover return value to be null instead to match the stated API (#92)

0.5.0 - 2021-09-01

Added

  • process heredoc syntax correctly when deciding what completion items to return for ADD and COPY (#90)
  • support heredoc syntax in ADD and COPY instructions when linting the Dockerfile (rcjsuen/dockerfile-utils#98)
  • flag duplicated escape parser directive declarations as being unnecessary (rcjsuen/dockerfile-utils#82)
  • flag duplicated CMD, ENTRYPOINT, and HEALTHCHECK instructions as being unnecessary diagnostics (rcjsuen/dockerfile-utils#82)

0.4.0 - 2021-08-08

Added

  • process heredoc syntax correctly when deciding what completion items to return (#87)
  • add heredoc syntax when validating RUN instructions (rcjsuen/dockerfile-utils#97)

Fixed

  • fix semantic highlighting issue seen in arguments spanning multiple lines that are contiguous with no whitespace (#84)
  • remove special handling of backslash characters in strings for semantic tokens (#88)

0.3.0 - 2021-04-11

Added

  • suggest working directories if editing the last argument of ADD and COPY instructions that aren't written in JSON (#77)
  • allow multiple arguments to be defined for ARG instructions to support Docker Engine 20.10 (rcjsuen/dockerfile-utils#92)
  • optimized range formatting so that it does not return unnecessary edits (#81)
  • optimized on type formatting so that it does not return unnecessary edits (#82)
  • a new FormatterSettings interface for defining ignoreMultilineInstructions to ignore instructions that span multiple lines (#83)
export interface FormatterSettings extends FormattingOptions {

    /**
     * Flag to indicate that instructions that span multiple lines
     * should be ignored.
     */
    ignoreMultilineInstructions?: boolean;
}

Changed

  • altered the following functions (their original signatures are below) to accept FormatterSettings instead of FormattingOptions, this is a non-breaking change as FormatterSettings extends FormattingOptions (#83)
    • format(string, FormattingOptions)
    • formatRange(string, Range, FormattingOptions)
    • formatOnType(string, Position, string, FormattingOptions)

Fixed

  • do not validate variable substitutions if found in CMD and ENTRYPOINT (rcjsuen/dockerfile-utils#89)
  • fix infinite loop issue when calculating semantic tokens for ARG or ENV instructions with nested comments (#74)
  • do not flag ? as an invalid modifier in variable substitutions (rcjsuen/dockerfile-utils#91)
  • prevent false positive by improving the parsing of an escape character and newline that immediately follows a label definition (rcjsuen/dockerfile-utils#95)

0.2.0 - 2021-01-20

Added

0.1.1 - 2020-12-24

Added

  • added a new CompletionCapabilities and CompletionItemCapabilities to more easily facilitate features related to CompletionItems (#71)
export interface CompletionItemCapabilities {
    /**
     * Indicates whether completion items for deprecated
     * entries should be explicitly flagged in the item.
     */
    deprecatedSupport?: boolean;
    /**
     * Describes the supported content types that can be used
     * for a CompletionItem's documentation field.
     */
    documentationFormat?: MarkupKind[];
    /**
     * Indicates whether the snippet syntax should be used in
     * returned completion items.
     */
    snippetSupport?: boolean;
    /**
     * Indicates that the client editor supports tags in CompletionItems.
     */
    tagSupport?: {
        /**
         * Describes the set of tags that the editor supports.
         */
        valueSet: CompletionItemTag[];
    }
}

export interface CompletionCapabilities {
    /**
     * Capabilities related to completion items.
     */
    completionItem?: CompletionItemCapabilities;
}
  • CompletionItemTag is now supported when completing on the MAINTAINER keyword (#70)
  • instructions with only an escape character as its argument should be flagged as not having any arguments (rcjsuen/dockerfile-utils#83)

Changed

  • Capabilities will now reference CompletionCapabilities instead of having the structure embedded (#71)
export interface Capabilities {
    /**
     * Capabilities related to completion requests.
     */
    completion?: CompletionCapabilities;
}

Fixed

  • ENV instructions with blank space operators will no longer be assigned a semantic token (#76)

0.1.0 - 2020-07-11

Added

  • resolve build stage references to support definition navigation (#67)
  • ARG and ENV instructions that span multiple lines with just a comment are now flagged as an error (rcjsuen/dockerfile-utils#78)
  • use DiagnosticTag to indicate if a Diagnostic is informing the user about a deprecation or not(rcjsuen/dockerfile-utils#80)

Fixed

  • build stages are no longer included as a link (#68)
  • allow embedded comments to immediately follow an ENV declaration (#69)
  • fix the semantic tokens calculation to allow flags to have options without a value and improved handling of multiline strings (#54)
  • correct ranges of linting errors if the error is on a multiline argument that is preceded by the escape character (rcjsuen/dockerfile-utils#77)
  • fix linting error caused by whitespace followed after the escape character (rcjsuen/dockerfile-utils#79)

0.0.12 - 2020-04-23

Fixed

  • improved semantic tokens support for strings and variables (#54)

0.0.11 - 2020-04-03

Added

  • support multiple directives when calculating a Dockerfile's symbols (#65)
  • RUN instructions with only flags and no arguments will now be raised as an error (rcjsuen/dockerfile-utils#76)

Fixed

  • multiline instructions with empty newlines will no longer throw an error during validation (rcjsuen/dockerfile-utils#71)
  • instruction keywords that span multiple lines will no longer be raised as an error (rcjsuen/dockerfile-utils#72)
  • embedded comments with an empty continuation line will no longer be raised as an error (rcjsuen/dockerfile-utils#73)
  • arguments that follow a non-leading # comment marker will no longer be dropped during validation (rcjsuen/dockerfile-utils#75)
  • fix parsing of embedded comments in multiline instructions that have a trailing escape character (rcjsuen/dockerfile-utils#74)
  • improved semantic tokens support for flags, flag options, and tokens that are split across multiple lines because of escape characters and embedded comments (#54)

0.0.10 - 2020-03-25

Added

  • all tokens are now assigned a semantic meaning for the experimental support of semantic tokens (#54)
  • support completion of the syntax parser directive (#57)
  • add hover support for the syntax parser directive (#58)

Fixed

  • significantly improved the experimental support for semantic tokens with various fixes (#54)
  • allow hovers to be displayed for instruction keywords that span multiple lines (#59)
  • correct hover resolution of a variable if it comes after a false comment in a multiline instruction (#61)
  • correct hover resolution of a variable that comes after an embedded comment with a trailing escape character in a multiline instruction (#62)
  • use plain text instead of Markdown content for the signature label of the escape parser directive (#64)

0.0.9 - 2020-02-12

Added

  • support completing of tags for published images on the Docker Store (#50)
  • support completion of the --platform flag for FROMs introduced in Docker CE 18.04 (#52)
  • support hover documentation for the --platform flag for FROMs introduced in Docker CE 18.04 (#53)
  • add validation of FROM's --platform flag introduced in Docker CE 18.04 (rcjsuen/dockerfile-utils#68)
    • ValidationCode.UNKNOWN_FROM_FLAG
  • warn if two escape parser directives are defined (rcjsuen/dockerfile-utils#70)
  • experimental work-in-progress support for retrieving the semantic tokens of a Dockerfile to support semantic highlighting (#54)
    • as the language server protocol design for this is not complete, this API is in flux and is subject to change or even outright removal
    • please use this API with caution

Fixed

0.0.8 - 2018-05-23

Added

Changed

  • upgraded the dependency of lodash from 4.17.5 to 4.17.11 to prevent ourselves from being exposd to CVE-2018-16487
    • as lodash was only being used in the example, there is no reason to believe that consumers of the dockerfile-language-service module itself was affected by this vulnerability
    • nonetheless, anyone that was using the example as a reference is encouraged to update themselves as well

Fixed

0.0.7 - 2018-12-29

Added

  • add support to test the validity of a rename at a given position (#40)
  • support folding of instructions that span multiple lines (#43)

Changed

  • upgraded example's dependencies to include fix to atob for CVE-2018-3745
    • anyone that was known to have used the example as a reference should ensure that they upgrade their dependency to atob

Fixed

  • ignore variables when validating directories for ARGs and COPYs (rcjsuen/dockerfile-utils#54)
  • allow build stages to be case insensitive when looking up its definition (#41)
  • allow build stages to be case insensitive when highlighting them (#41)
  • allow build stages to be case insensitive when renaming them (#41)
  • consider all build stages with the same name in FROMs when highlighting or renaming (#42)

0.0.6 - 2018-08-19

Added

  • updated Capabilities interface to support customizing how folding ranges should be processed and returned (#33)
export interface Capabilities {
    /**
     * Capabilities related to folding range requests.
     */
    foldingRange?: {
        /**
         * If set, the service may choose to return ranges that have
         * a bogus `startCharacter` and/or `endCharacter` and/or to
         * leave them as undefined.
         */
        lineFoldingOnly?: boolean;
        /**
         * The maximum number of folding ranges to return. This is a
         * hint and the service may choose to ignore this limit.
         */
        rangeLimit?: number;
    };
}

Fixed

0.0.5 - 2018-06-29

Added

  • updated Capabilities interface to support the deprecated property on CompletionItems (#35)
interface Capabilities {
    /**
     * Capabilities related to completion requests.
     */
    completion?: {
        /**
         * Capabilities related to completion items.
         */
        completionItem?: {
            /**
             * Indicates whether completion items for deprecated
             * entries should be explicitly flagged in the item.
             */
            deprecatedSupport?: boolean;
        }
    }
}
  • add support for indicating that the MAINTAINER instruction is deprecated when returning it as a completion item (#35)
  • add support for indicating that the MAINTAINER instruction is deprecated when returning the document's list of symbols (#36)
  • add support for populating targets in document links in a resolution step (#38)
  • flag FROM instructions that refer to an invalid image digest in a private registry with a port as an error (rcjsuen/dockerfile-utils#42)
  • flag variables that have an invalid modifier set (rcjsuen/dockerfile-utils#38)
  • warn if ARG instruction does not define a name for the variable (rcjsuen/dockerfile-utils#45)
  • flag incorrectly quoted arguments for ARG, ENV, and LABEL (rcjsuen/dockerfile-utils#40)

Changed

  • upgraded the dependency of Mocha from 3.x to 5.x
    • versions prior to 4.x of Mocha dependended on Growl 1.9.2 which contained a security vulnerability
    • as Mocha is a devDependencies module, there is no reason to believe that consumers of the dockerfile-language-service module itself was affected by this vulnerability

Fixed

  • image tag completion inserts extra text if word boundary is ambiguous (#39)
  • resolve variables to uninitialized ARGs with ARGs at the top of the Dockerfile if they exist (#34)
  • fix incorrect validation warning in ARG, ENV, and LABEL instructions caused by quotes being used in variable replacements (rcjsuen/dockerfile-utils#36)
  • fix incorrect validation of tagged images caused by FROM referencing images in a private registry (rcjsuen/dockerfile-utils#39)
  • allow variables to be used in a FROM's base image argument (rcjsuen/dockerfile-utils#43)
  • handle ARG instructions with escaped newlines that lead to an EOF comment (rcjsuen/dockerfile-utils#44)

0.0.4 - 2018-04-16

Fixed

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[];
        }
    }
}

Fixed

0.0.2 - 2018-03-08

Added

  • new Capabilities interface for defining what features the language service should support and enable
interface Capabilities {
    /**
     * Capabilities related to completion requests.
     */
    completion?: {
        /**
         * Capabilities related to completion items.
         */
        completionItem?: {
            /**
             * Indicates whether the snippet syntax should be used in
             * returned completion items.
             */
            snippetSupport?: boolean;
        }
    };
    /**
     * Capabilities related to hover requests.
     */
    hover?: {
        /**
         * Describes the content type that should be returned for hovers.
         */
        contentFormat?: MarkupKind[];
    }
}
  • new computeCommandEdits function to DockerfileLanguageService (#4)
  • update documentation to state that ARG was introduced in Docker 1.9 (#7)
  • allow hover information to be returned in Markdown or plain text (#14)

Changed

  • change the signature of DockerfileLanguageService's computeHighlightRanges function by removing its first URI string parameter (#15)
import { Position } from 'vscode-languageserver-types';
// removed
let ranges = service.computeHighlightRanges(uri, content, Position.create(3, 1));
// replace the above with the following
let ranges = service.computeHighlightRanges(content, Position.create(3, 1));
  • change the signature of DockerfileLanguageService's computeCompletionItems function by removing its final boolean parameter (#23)
import { Position } from 'vscode-languageserver-types';
// removed
let ranges = service.computeCompletionItems(content, Position.create(3, 1), true);
// replace the above with the following
service.setCapabilities({ completion: { completionItem: { snippetSupport: true } } });
let ranges = service.computeCompletionItems(content, Position.create(3, 1));

Fixed

  • change documentation to state that STOPSIGNAL was added in Docker 1.9 instead of Docker 1.12 (#6)
  • align active parameter amongst all displayed signatures for a FROM with a build stage name (#8)
  • fix validate function to read the provided settings (#18)
  • use a non-zero range for the diagnostic if FROM's base image's digest is the empty string (rcjsuen/dockerfile-utils#21)
  • ignore multiple CMD, ENTRYPOINT, and HEALTHCHECK instructions in a Dockerfile if there is only ever one in a build stage (rcjsuen/dockerfile-utils#22)
  • handle invalid decimal values without a leading zero for duration flags (rcjsuen/dockerfile-utils#23)
  • ignore and return null for hover computations with an invalid position (#22)

Removed

  • replaced DockerfileLanguageService's createWorkspaceEdit with a computeCommandEdits function (#4)
// removed
let workspaceEdit = service.createWorkspaceEdit(dockerfileContent, commandId, args);
// replace the above with the following
let uri = ...; // the URI of the opened Dockerfile
let edits = service.computeCommandEdits(dockerfileContent, commandId, args);
let workspaceEdit = {
  changes: {
    [ uri ]: edits
  }
}

0.0.1 - 2018-02-17

Added

  • created a language service that exposes an API similar to that defined by the language server protocol
    • validation and proposed resolution of said errors and warnings
      • textDocument/publishDiagnostics
      • textDocument/codeAction
      • workspace/executeCommand
    • navigation and editing
      • textDocument/definition
      • textDocument/documentHighlight
      • textDocument/documentSymbol
      • textDocument/documentLink
    • code completion
      • completionItem/resolve
      • textDocument/completion
      • textDocument/signatureHelp
    • formatting
      • textDocument/formatting
      • textDocument/onTypeFormatting
      • textDocument/rangeFormatting
    • contextual information
      • textDocument/rename
      • textDocument/hover