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.

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

Add types for changelog-filename-regex #45770

Merged
merged 1 commit into from Jul 6, 2020
Merged

Add types for changelog-filename-regex #45770

merged 1 commit into from Jul 6, 2020

Conversation

JamieMagee
Copy link
Contributor

@JamieMagee JamieMagee commented Jun 29, 2020

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.

@typescript-bot typescript-bot added New Definition This PR creates a new definition package. Where is GH Actions? GH Actions didn't give a response to this PR labels Jun 29, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jun 29, 2020

@JamieMagee Thank you for submitting this PR!

This is a live comment which I will keep updated.

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 merge 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": 45770,
  "author": "JamieMagee",
  "owners": [],
  "dangerLevel": "ScopedAndConfiguration",
  "headCommitAbbrOid": "c353e59",
  "headCommitOid": "c353e595fe3af981327b2b89129667dd1019eab3",
  "mergeIsRequested": false,
  "stalenessInDays": 6,
  "lastCommitDate": "2020-06-29T08:38:07.000Z",
  "lastCommentDate": "2020-06-29T08:42:31.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/45770/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": false,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": true,
  "packages": [
    "changelog-filename-regex"
  ],
  "files": [
    {
      "filePath": "types/changelog-filename-regex/changelog-filename-regex-tests.ts",
      "kind": "test",
      "package": "changelog-filename-regex"
    },
    {
      "filePath": "types/changelog-filename-regex/index.d.ts",
      "kind": "definition",
      "package": "changelog-filename-regex"
    },
    {
      "filePath": "types/changelog-filename-regex/tsconfig.json",
      "kind": "package-meta",
      "package": "changelog-filename-regex"
    },
    {
      "filePath": "types/changelog-filename-regex/tslint.json",
      "kind": "package-meta",
      "package": "changelog-filename-regex"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 0,
  "isChangesRequested": false
}

@typescript-bot typescript-bot removed the Where is GH Actions? GH Actions didn't give a response to this PR label Jun 29, 2020
@typescript-bot typescript-bot moved this from Other to Waiting for Code Reviews in New Pull Request Status Board Jun 29, 2020
@danger-public
Copy link

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

changelog-filename-regex (unpkg)

was missing the following properties:

  1. dotAll

Generated by 🚫 dangerJS against c353e59

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Jun 29, 2020
@typescript-bot
Copy link
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 changelog-filename-regex with its source on master.

Comparison details 📊
Batch compilation
Type count 2104
Assignability cache size 95
Language service measurements
Samples taken 3
Identifiers in tests 3
getCompletionsAtPosition
    Mean duration (ms) 111.3
    Mean CV 32.8%
    Worst duration (ms) 126.5
    Worst identifier changelogFilenameRegex
getQuickInfoAtPosition
    Mean duration (ms) 91.8
    Mean CV 19.8%
    Worst duration (ms) 94.2
    Worst identifier changelogFilenameRegex
System information
Node version v12.18.1
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-1089-azure

@typescript-bot typescript-bot moved this from Needs Maintainer Review to Needs Maintainer Action in New Pull Request Status Board Jul 6, 2020
@weswigham weswigham merged commit 19e0ee9 into DefinitelyTyped:master Jul 6, 2020
@typescript-bot typescript-bot removed this from Needs Maintainer Action in New Pull Request Status Board Jul 6, 2020
@typescript-bot
Copy link
Contributor

I just published @types/changelog-filename-regex@2.0.0 to npm.

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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants