Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions types/netrc/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*
!**/*.d.ts
!**/*.d.cts
!**/*.d.mts
!**/*.d.*.ts
14 changes: 14 additions & 0 deletions types/netrc/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/// <reference types="node" />

import fs from "fs";

export = netrc;

declare function netrc(file?: fs.PathLike): netrc.Machines;

declare namespace netrc {
type Machines = Record<string, Record<string, string>>;
function parse(content: string): Machines;
function format(machines: Machines): string;
function save(machines: Machines): void;
}
28 changes: 28 additions & 0 deletions types/netrc/netrc-tests.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import netrc from "netrc";

const machines = netrc(".mynetrc");

const { login, password } = machines["example.com"];
// $ExpectType string
login;
// $ExpectType string
password;

// $ExpectType string
netrc.format(machines);

machines["github.com"] = {
login: "AzureDiamond",
password: "hunter2",
};
// $ExpectType void
netrc.save(machines);

// netrc-valid-w-comment from camshaft/netrc
const content = `# I am a comment
machine github.com
password 123
login CamShaft
# I am another comment`;
// $ExpectType Machines
netrc.parse(content);
20 changes: 20 additions & 0 deletions types/netrc/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"private": true,
"name": "@types/netrc",
"version": "0.1.9999",
"projects": [
"https://github.com/CamShaft/netrc#readme"
],
"dependencies": {
"@types/node": "*"
},
"devDependencies": {
"@types/netrc": "workspace:."
},
"owners": [
{
"name": "Nate Kean",
"githubUsername": "nate-kean"
}
]
}
19 changes: 19 additions & 0 deletions types/netrc/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"compilerOptions": {
"module": "node16",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictFunctionTypes": true,
"strictNullChecks": true,
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"netrc-tests.ts"
]
}