Skip to content

[i18next-fs-backend] create definitions#47072

Merged
elibarzilay merged 2 commits intoDefinitelyTyped:masterfrom
Quantumlyy:i18next-fs-backend
Aug 28, 2020
Merged

[i18next-fs-backend] create definitions#47072
elibarzilay merged 2 commits intoDefinitelyTyped:masterfrom
Quantumlyy:i18next-fs-backend

Conversation

@Quantumlyy
Copy link
Copy Markdown
Contributor

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. (Run with npm test.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should be present and it shouldn't have any additional or disabling of rules. Just content as { "extends": "dtslint/dt.json" }. If for reason the some rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • 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.
  • Include tests for your changes
  • If you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }. If for reason the any rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

@typescript-bot typescript-bot added the New Definition This PR creates a new definition package. label Aug 27, 2020
@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented Aug 27, 2020

@QuantumlyTangled Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ❌ Only a DT maintainer can approve changes when there are new packages added

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 47072,
  "author": "QuantumlyTangled",
  "owners": [],
  "dangerLevel": "ScopedAndConfiguration",
  "headCommitAbbrOid": "99c0bd0",
  "headCommitOid": "99c0bd0b5597a2bd83d5c2f0045a6ac996869f39",
  "mergeIsRequested": false,
  "stalenessInDays": 0,
  "lastPushDate": "2020-08-27T09:02:55.000Z",
  "lastCommentDate": "2020-08-27T09:02:55.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/47072/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Well-liked by everyone",
  "newPackages": [
    "i18next-fs-backend"
  ],
  "packages": [
    "i18next-fs-backend"
  ],
  "files": [
    {
      "path": "types/i18next-fs-backend/i18next-fs-backend-tests.ts",
      "kind": "test",
      "package": "i18next-fs-backend"
    },
    {
      "path": "types/i18next-fs-backend/index.d.ts",
      "kind": "definition",
      "package": "i18next-fs-backend"
    },
    {
      "path": "types/i18next-fs-backend/package.json",
      "kind": "package-meta",
      "package": "i18next-fs-backend",
      "suspect": "edited"
    },
    {
      "path": "types/i18next-fs-backend/tsconfig.json",
      "kind": "package-meta",
      "package": "i18next-fs-backend",
      "suspect": "created"
    },
    {
      "path": "types/i18next-fs-backend/tslint.json",
      "kind": "package-meta-ok",
      "package": "i18next-fs-backend"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-08-27T09:15:19.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 1,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Copy Markdown
Contributor

🔔 @QuantumlyTangled — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@typescript-bot
Copy link
Copy Markdown
Contributor

👋 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?

These typings are for a package that doesn’t yet exist on master, so I don’t have anything to compare against yet! In the future, I’ll be able to compare PRs to i18next-fs-backend with its source on master.

Comparison details 📊
Batch compilation
Type count 2387
Assignability cache size 137
Language service measurements
Samples taken 93
Identifiers in tests 93
getCompletionsAtPosition
    Mean duration (ms) 93.2
    Mean CV 23.4%
    Worst duration (ms) 124.4
    Worst identifier JSON
getQuickInfoAtPosition
    Mean duration (ms) 90.9
    Mean CV 22.9%
    Worst duration (ms) 117.1
    Worst identifier init
System information
Node version v12.18.3
CPU count 2
CPU speed 2.294 GHz
CPU model Intel(R) Xeon(R) CPU E5-2673 v4 @ 2.30GHz
CPU Architecture x64
Memory 6.8 GiB
Platform linux
Release 4.15.0-1092-azure

@typescript-bot typescript-bot added the Other Approved This PR was reviewed and signed-off by a community member. label Aug 27, 2020
@elibarzilay elibarzilay merged commit a4b6036 into DefinitelyTyped:master Aug 28, 2020
chivesrs pushed a commit to chivesrs/DefinitelyTyped that referenced this pull request Sep 2, 2020
danielrearden pushed a commit to danielrearden/DefinitelyTyped that referenced this pull request Sep 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

New Definition This PR creates a new definition package. Other Approved This PR was reviewed and signed-off by a community member.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants