[@ember/string] augment @ember/string with htmlSafe and isHTMLSafe

[jamescdavis]

#50545 prematurely removed htmlSafe and isHTMLSafe from @ember/string. This adds them back because they continue to be available to be imported from there in addition to @ember/template (this is deprecated, but not removed). I've added them back using module augmentation so that they will augment the types shipped with the external @ember/string package when present (it's a dependency of ember-data starting with ember-data@3.24. Module augmentation does not allow simply re-exporting from @ember/template, but, rather than completely redefine the types for these functions, I grab the parameter and return types from @ember/template and use them here.

I've opened emberjs/ember.js#19339 to actually deprecate this in the Ember codebase.

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm test <package to test>.

Select one of these and delete the others:

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes:
  • htmlSafe and isHTMLSafe are added to @ember/string here
    (Ember.String is importable as @ember/string in Ember)
  • definition of htmlSafe
  • definition of isHTMLSafe
• If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

[typescript-bot]

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

Comparison details 📊

	master	#50653	diff
Batch compilation
Memory usage (MiB)	81.1	71.1	-12.3%
Type count	10471	10505	0%
Assignability cache size	3638	3650	0%
Language service
Samples taken	32	40	+25%
Identifiers in tests	32	40	+25%
getCompletionsAtPosition
Mean duration (ms)	380.9	373.6	-1.9%
Mean CV	13.3%	11.6%
Worst duration (ms)	438.5	513.0	+17.0%
Worst identifier	capitalize	htmlSafe
getQuickInfoAtPosition
Mean duration (ms)	373.3	365.1	-2.2%
Mean CV	12.6%	12.3%
Worst duration (ms)	434.6	430.1	-1.0%
Worst identifier	w	w

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

[jamescdavis]

@eramod I'd love it if you could test this on your code.

[typescript-bot]

@jamescdavis Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

• ember__string on npm, on unpkg (author is owner)
  • owner-approval: @dfreeman

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Most recent commit is approved by type definition owners, DT maintainers or others

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 50653,
  "author": "jamescdavis",
  "headCommitOid": "bf56063514bd6294ab082d8dbebd89a4e93c3eee",
  "lastPushDate": "2021-01-15T19:03:44.000Z",
  "lastActivityDate": "2021-01-18T17:03:30.000Z",
  "maintainerBlessed": false,
  "mergeOfferDate": "2021-01-18T17:01:34.000Z",
  "mergeRequestDate": "2021-01-18T17:03:30.000Z",
  "mergeRequestUser": "jamescdavis",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "ember__string",
      "kind": "edit",
      "files": [
        {
          "path": "types/ember__string/ember__string-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/ember__string/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "mike-north",
        "chriskrycho",
        "dfreeman",
        "jamescdavis"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "dfreeman",
      "date": "2021-01-18T17:00:58.000Z",
      "isMaintainer": false
    }
  ],
  "ciResult": "pass"
}

[typescript-bot]

🔔 @mike-north @chriskrycho @dfreeman — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

[typescript-bot]

@jamescdavis Everything looks good here. Great job! I am ready to merge this PR (at bf56063) on your behalf.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@mike-north, @chriskrycho, @dfreeman: you can do this too.)

[jamescdavis]

Ready to merge

[typescript-bot]

I just published @types/ember__string@3.16.3 to npm.