Commit Graph

521 Commits

Author SHA1 Message Date
Jack Bates
b87e8efce6 [README] Create an OTHER_FILES.txt section (#50149) 2020-12-19 07:07:36 -05:00
Eli Barzilay
9b02f6817a Quote some missed file names (#50193)
Mostly in section headers, but elsewhere too.

Also switch from `<my package>` to `<my-package>`.
2020-12-19 05:02:49 -05:00
João Neto
a73dd551ba Update guidelines for when using npm v7 (#50022)
Running `npm install` when using npm v7 results in the following error:
    npm ERR! code ERESOLVE
    npm ERR! ERESOLVE unable to resolve dependency tree
    npm ERR!
    npm ERR! While resolving: definitely-typed@0.0.3
    npm ERR! Found: typescript@4.2.0-dev.20201208
    npm ERR! node_modules/typescript
    npm ERR!   dev typescript@"next" from the root project
    npm ERR!
    npm ERR! Could not resolve dependency:
    npm ERR! peer typescript@">= 3.0.0-dev || >= 3.1.0-dev || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.7.0-dev || >= 3.8.0-dev || >= 3.9.0-dev || >= 4.0.0-dev" from dtslint@4.0.6
    npm ERR! node_modules/dtslint
    npm ERR!   dev dtslint@"latest" from the root project
    npm ERR!   peer dtslint@"*" from @definitelytyped/dtslint-runner@0.0.64
    npm ERR!   node_modules/@definitelytyped/dtslint-runner
    npm ERR!     dev @definitelytyped/dtslint-runner@"latest" from the root project
    npm ERR!
    npm ERR! Fix the upstream dependency conflict, or retry
    npm ERR! this command with --force, or --legacy-peer-deps
    npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
2020-12-14 17:52:22 +00:00
Jack Bates
f0b4d3853b [README] Create a tsconfig.json section (#49945) 2020-12-14 17:04:49 +00:00
MaySoMusician
b350ea4ba1 [README] Add Japanese-translated version (#49779)
* Add README.ja.md for translation

* Translate intro of README into Japanese

* Translate table of contents of README into Japanese

* Translate current status section of README into Japanese

* Translate what-are-declaration-files section of README into Japanese

* Translate testing (with real code) section of README into Japanese

* Translate section about editing/creating packages in README into Japanese

* Translate common mistakes section of README into Japanese

* Translate remove a package section of README into Japanese

* Translate sections about linting and testing of README into Japanese

* Translate Definition Owners section of README into Japanese

* Translate FAQ section of README into Japanese

* Translate License section of README into Japanese

* Fix some typos etc.

* Remove whitespace next to code block in full-width parentheses

* Add link to README.ja.md in README.md

* Add comments to ask translators to add link to README.ja.md in other language versions

* Fix heading anchors

* Fix translation of 'in order of how much they inconvenience users of a library'

* Update some expressions

* Apply suggestions by sasurau4 from code review

Co-authored-by: Daiki Ihara <sasurau4@gmail.com>

Co-authored-by: Daiki Ihara <sasurau4@gmail.com>
2020-12-14 13:18:59 +00:00
Jack Bates
b0883d8983 Move tslint.json advice from PULL_REQUEST_TEMPLATE.md (#49575)
* Move tslint.json advice from PULL_REQUEST_TEMPLATE.md

* Apply suggestions from code review

Co-authored-by: Eli Barzilay <eli@barzilay.org>

* Apply suggestions from code review

Co-authored-by: Eli Barzilay <eli@barzilay.org>

* Keep the most important bit in PULL_REQUEST_TEMPLATE.md

Co-authored-by: Eli Barzilay <eli@barzilay.org>
2020-12-11 16:48:05 -08:00
Eli Barzilay
a8c4f6d763 Update lifecycle image, using svg (#49944) 2020-12-04 08:43:38 -05:00
Jack Bates
b94b68318f [README] Create a package.json section (#49686)
* [README] Create a package.json section

* Apply suggestions from code review

Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>

Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
2020-12-03 17:07:00 +00:00
MaySoMusician
7658f9cfd7 Fix wrong dash in prettier command in README.md (#49756) 2020-11-24 11:56:32 -08:00
Marko Kaznovac
87db076e48 Bugfix not-needed script argument parsing (#49718)
* fix not-needed script regression, introduced by removing of the sourceRepoURL parameter in #49620 (3868b76e67)

* doc fix example of npm run not-needed
2020-11-23 16:15:32 -08:00
Jack Bates
947ad2efb9 [README] Update references to DefinitelyTyped-tools (#49685) 2020-11-20 17:03:47 -08:00
Jack Bates
b8b715c757 [README] Add escapes missed in #49636 (#49671) 2020-11-19 10:34:28 -08:00
Jack Bates
eee07ad673 Improve tests documentation (#49636)
Co-authored-by: Eli Barzilay <eli@barzilay.org>

Co-authored-by: Eli Barzilay <eli@barzilay.org>
2020-11-18 15:53:33 -08:00
Jack Bates
c054da5f3d [README] Move section to match table of contents (#49617) 2020-11-17 09:58:39 -08:00
Jack Bates
3868b76e67 Remove sourceRepoURL from notNeededPackages.json (#49620)
Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
2020-11-16 16:18:33 -08:00
Jack Bates
93a5fd6d6e [README] Update translations' tables of contents (#49614) 2020-11-16 15:43:29 -08:00
Eli Barzilay
683e602b11 README: update and sync TOC & headers (#49489) 2020-11-11 14:34:51 -05:00
Eli Barzilay
010b39c203 Revert README changes (#48958)
Revert the erroneously-merged changes to the READMEs, and instead just
leave some minor edits in the main `README.md`.
2020-10-20 14:09:09 -04:00
Jack Bates
b69d248b8e Run prettier --write *.md (#48952)
Sorry, I tried, but turns out that I was naive -- there's too much stuff to go over, and especially with languages that I can't read I worry about mistakes.  More than that, one of the changes I *did* like was how it organizes tables in a readable way, but then I realized that some of the translations had their own text in the tables and I don't even know if it's common (or possible) to use monospace font, so this can end up messier than what it starts with.

So overall, I think that it's best to leave the texts as-is.

I could do that over just the english version, and revert the edits in the other files, and hope that translations will eventually catch up --- but that would leave much fewer changes, so it might be pointless.
2020-10-20 13:42:28 -04:00
Beau Gunderson
49eaad3968 🤖 Merge PR #48439 [ip-address] remove ip-address; types were inlined by @beaugunderson
* deprecate @types/ip-address

* `npm run test-all` is more useful for this check
2020-10-05 14:23:51 -04:00
Jack Bates
2132d32e3c Use wildcards for scope path mappings (#47089) 2020-09-25 16:07:58 -07:00
Andrew Branch
0ae6bba4e3 Update allowedPackageJsonDependencies instructions 2020-09-24 09:53:15 -07:00
Nathan Shively-Sanders
6dcabd6320 Switch README to discord from gitter (#47886) 2020-09-22 11:45:33 -07:00
Nathan Shively-Sanders
cc6d4d4b19 Update README with Minimum TypeScript Version instructions (#47747) 2020-09-17 16:17:22 -07:00
Android Dev Notes
1cb79ff5d9 Fix typos (#47640) 2020-09-16 16:16:50 -07:00
Nathan Shively-Sanders
f87f81730a Update minimum supported version to 3.2 in readme (#47646)
Also update instructions for `npm test` in PR template.
2020-09-16 11:17:04 -07:00
Piotr Błażejewicz (Peter Blazejewicz)
4420fc2be4 docs(README): amend #47282 (#47309)
Minor modification to `npm test` to align with #47282 changes.
2020-09-08 07:47:41 -04:00
Nathan Shively-Sanders
679571bbfc Rename test tasks (#47282)
* Add `npm test` instructions to README

* Rename test tasks

lint -> test
test -> test-all

lint is still around for backward compatibility

* add missed close quote
2020-09-04 15:12:35 -07:00
Orta Therox
f3b43ae322 Updates the README to reference what happens when you make a PR, and why (#47237) 2020-09-03 15:07:45 -04:00
Nathan Shively-Sanders
f46848bcc7 Update dtslint-runner badge to new pipeline (#47256)
* update dtslint-runner badge to new pipeline

* revert mistaken test runner change
2020-09-03 09:53:32 -07:00
Nathan Shively-Sanders
935afa0288 update typesVersions instructions (#47215) 2020-09-02 08:15:50 -07:00
Nathan Shively-Sanders
8f70fedcce add 4.0/deprecate 3.0 in README (#46930) 2020-08-20 13:32:10 -07:00
Maxim Mazurok
f5b156404c Added missing of in README (#45373)
"... at the end the first line" should be "... at the end *of* the first line"
2020-06-09 10:02:46 -04:00
Thiago
c7daedc51a Adds Brazilian Portuguese README (#44964)
* Adds Brazilian Portuguese README

Co-Authored-By: Pedro Campos <pedro@cdias.dev>

* Fixes some typos

* Changes End of Line Sequence to LF

* Translates anchors

Co-authored-by: Pedro Campos <pedro@cdias.dev>
2020-05-26 15:24:26 -07:00
Nathan Shively-Sanders
9ebc05c7f5 Document removed support for TS 2.9 (#44968) 2020-05-26 11:33:26 -07:00
Orta
553e6ae6c2 Make it "Definitely Typed" and revise docs on Definition Owners (#44679)
* Improve the docs around definition owners

* More Def Owners readme changes

* More Definition Owners docs

* The great Definitely Typeding
2020-05-20 13:06:52 -07:00
Cameron Little
7c3786c61b Fix - Update the PR project board link in READMEs (#44480) 2020-05-05 10:45:11 -07:00
Nathan Shively-Sanders
e3f5f98831 Update support schedule in READMEs (#44402) 2020-05-01 08:34:05 -07:00
Andrew Branch
a095649c04 Add link to infrastructure status issue 2020-04-28 18:20:20 -07:00
Orta
72c1e33e13 Improve docs on 'testing' a dt module (#43748)
* Improve docs on 'testing' a dt module

* Duplicate saying how you can test your tests

* Apply suggestions from code review

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

* Update docs with recommendations

* Apply suggestions from code review

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

* Changes from reviews and link from the PR template

Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
2020-04-11 13:40:47 -04:00
Kagami Sascha Rosylight
bc6280c39e Update README.ko.md (#42958) 2020-03-06 13:58:01 -08:00
Nikita Galkin
958ad18f21 Update Readme for Russian language (#42881) 2020-03-06 09:18:27 -08:00
Nathan Shively-Sanders
09dc238010 Add deprecation schedule (#42834)
* Add deprecation schedule

and explain tags a bit more fully

* improved formatting
2020-03-04 15:39:36 -08:00
Rohit Gohri
865ae1f9a8 Add prettier npm script and update command in docs (#42365) 2020-02-14 14:42:48 -05:00
Piotr Błażejewicz (Peter Blazejewicz)
699dd6b2e2 docs(readme): Add hint about prettier ignore (#41593)
This is an aftermath of problem discussed here:
https://github.com/DefinitelyTyped/DefinitelyTyped/pull/41567#discussion_r365882974

Thanks!
2020-01-17 11:43:24 -05:00
Orta
9f2b299e70 Adds some admin docs (#41063)
* Adds some admin docs

* Update admin manual

* Update docs/admin.md

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

* More docs on admin

Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
2019-12-24 16:34:27 +00:00
Nathan Shively-Sanders
dd4016e519 Update status badges (#40978)
Point to dev.azure.com/DefinitelyTyped instead of /Microsoft.
2019-12-11 13:30:12 -08:00
Nathan Shively-Sanders
7926ae9ff5 Update new package instructions (#40677)
1. Only index.d.ts is allowed in files list; all other d.ts files should be
referenced from it.
2. Unreferenced files that nonetheless need to ship can be added to
OTHER_FILES.txt
2019-11-26 12:48:58 -08:00
Nathan Shively-Sanders
9314b64275 Streamline references to old Typescript versions. (#40418)
Also mention triple-slash `types` references.
2019-11-15 08:46:48 -08:00
Nathan Shively-Sanders
a4560c4eb2 Update readme for 2.0-2.7 deprecation (#40222)
* Update readme for 2.0-2.7 deprecation

* Add example of dist-tags with react

* shorten dist-tag table
2019-11-07 13:48:58 -08:00