object-literal-sort-keys and accented words

[rodrigojcmello]

Bug Report

• TSLint version: 5.11.0
• TypeScript version: 3.0.3
• Running TSLint via: VSCode

TypeScript code being linted

interface IAdicionarItem {
    autor: string; // these 3 items were sorted alphabetically by vscode (no tslint was used for this), here it is right.
    título: string; // i with accent 
    type: 'ADICIONAR_ITEM';
}

export const adicionarItem = (autor: string, título: string): IAdicionarItem => ({
    autor,
    título, // "i" with accent should still come before "y"
    type: 'ADICIONAR_ITEM', // [tslint] The key 'type' is not sorted alphabetically (object-literal-sort-keys)
});

with tslint.json configuration:

{
    "defaultSeverity": "warning",
    "extends": [
        "tslint:recommended",
        "tslint-react"
    ],
    "jsRules": {},
    "rules": {
        "quotemark": [
            true,
            "single",
            "jsx-single"
        ],
        "jsx-no-multiline-js": false,
        "jsx-no-lambda": false,
        "no-console": false
    },
    "rulesDirectory": []
}

Actual behavior

Words with accents must be in the end so there is no error / warning in TSLint

Expected behavior

Items should be sorted alphabetically considering accents without any TSLint error / warning

[pe8ter]

Looks like JavaScript has some options for an easy win:

https://davidwalsh.name/sorting-strings-accented-characters
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare

I could make a PR if this. I'd like to know if using localeCompare() for all sorting would be an acceptable solution, or if adding an option to use this as the sort function would be preferable.

[johnwiseheart]

I think its probably preferable to add an option for this to avoid throwing errors on code that was previously "correct". In the next major version we can turn on the option by default.

[pe8ter]

@rodrigojcmello Feature released in https://github.com/palantir/tslint/releases/tag/5.12.0.

See new option locale-compare in https://palantir.github.io/tslint/rules/object-literal-sort-keys/.

[johnwiseheart]

Since it’s been released, I think we can close this issue.