Skip to content

Latest commit

 

History

History
13 lines (8 loc) · 963 Bytes

README.md

File metadata and controls

13 lines (8 loc) · 963 Bytes

Which version of faker introduced each method?

Step 1: ./1-getVersions.sh uses the npm view command to write out a JSON list of versions to versions.json

Step 2: node ./2-parse.js loops through each element of version.json, and if it's not a beta version, runs npm install @faker-js/faker@VERSION, followed by calling methods.js. methods.js writes a text file into methods/method-X.Y.Z with a plain text list of all methods of the form (faker.foo.bar). Note v6.1.0 fails.

Step 3: node ./3-since.js > since.txt loops backwards through the text files and for each method in the latest version, finds the oldest text file which contains this method, and writes out the results to since.txt

Step 4: node ./4-docs.js based on since.txt, locates the comment before each method in the faker-js source code (assumed to be located at ../faker) and adds a @since annotation to it

The resulting PR is https://github.com/faker-js/faker/pull/1337/files