Skip to content
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

Jump to bottom

chore: Prepare 3.0.0 release #752

Merged
merged 1 commit into from
May 2, 2024
Merged

chore: Prepare 3.0.0 release #752

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
41 changes: 40 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,46 @@
# Changelog

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

## 3.0.0 - 2024-05-02
[Full Changelog](https://github.com/nextcloud-libraries/nextcloud-l10n/compare/v2.2.0...v3.0.0)

### Breaking changes
Instead of also sanitizing the replacing variables, now only the result is sanitized, see [pull request #648](https://github.com/nextcloud-libraries/nextcloud-l10n/pull/648).
Copy link
Contributor

Choose a reason for hiding this comment

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

While I see the usecase, it's very problematic when a string contains 2 inputs that are user input 🙈
Maybe a second option would be better? 🤔

Copy link
Contributor Author

@susnux susnux May 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We can also add e.g. this API:

const userinput = '...'
t(
    'foo',
    '{a}link to {userinput}{end_a}',
    {
        a: {
            value: '<a>',
            escape: false,
        },
        end_a: {
            value: '</a>',
            escape: false,
        },
        userinput,
    },
)

Meaning options per placeholder


This will improve the performance if multiple placeholders are used and it allows this,
while the string is still sanitized:
```js
t(
'See {linkstart}documentation{linkend}',
{
linkstart: '<a ...>',
linkend: '</a>',
},
// No number
undefined,
{
// Do not escape the result as we want the HTML anchor element
escape: false,
}
)
```

### Added
* feat: export aliases `t` and `n` for `translate` and `translatePlural`

### Fixed
* fix!: Only sanitize the result string when replacing variables

### Changed
* Update NPM to latest LTS v10
* Migrate to vite for transpiling and vitest for testing
* chore: Added more tests for special cases on plural forms
* chore(deps): Bump tough-cookie to 4.1.3
* chore(deps): Bump postcss to 8.4.31
* chore(deps): Bump @nextcloud/typings to 1.8.0
* chore(deps): Bump dompurify to 3.1.1
* chore(deps): Bump @nextcloud/router to 3.0.1

## 2.2.0 - 2023-06-26

[Full Changelog](https://github.com/nextcloud-libraries/nextcloud-l10n/compare/v2.1.0...v2.2.0)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nextcloud/l10n",
"version": "2.2.0",
"version": "3.0.0",
"description": "Nextcloud L10n helpers for apps and libraries",
"type": "module",
"main": "dist/index.cjs",
Expand Down
Loading