Skip to content

Commit fe09d69

Browse files
committed
docs: update paths.ts
1 parent 7adfeca commit fe09d69

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

src/lib/paths.ts

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ const REPEAT_FILENAMES = ["readme", "index", '__init__.py'];
1313
/**
1414
* Get metadata for a given path.
1515
*
16-
* This is done in one function call to save having to do separate calls or having to the built-in
17-
* string methods all over the project.
16+
* This is done in one function call to save having to do separate calls or
17+
* having to the built-in string methods all over the project.
1818
*
19-
* Info is derived based on the input value as string, not whether the path to a file that exists or
20-
* not.
19+
* Info is derived based on the input value as string, not whether the path to a
20+
* file that exists or not.
2121
*
22-
* Note that `path.extname` is already smart enough to detect only the last extension if there are
23-
* multiple dots as see extension as empty string if it is '.filename'. Note that extension will
24-
* have a dot.
22+
* Note that `path.extname` is already smart enough to detect only the last
23+
* extension if there are multiple dots as see extension as empty string if it
24+
* is '.filename'. Note that extension will have a dot.
2525
*/
2626
export function splitPath(filePath: string): SplitPathResult {
2727
const dir = path.dirname(filePath),
@@ -38,8 +38,9 @@ export function splitPath(filePath: string): SplitPathResult {
3838
/**
3939
* Change file path to a more readable format.
4040
*
41-
* The idea is to show just the filename, to keep things short. README and index files can be
42-
* confusing as there might be be a few in a project, so those are kept as paths.
41+
* The idea is to show just the filename, to keep things short. README and index
42+
* files can be confusing as there might be be a few in a project, so those are
43+
* kept as paths.
4344
*/
4445
export function friendlyFile(filePath: string) {
4546
const { name } = splitPath(filePath);
@@ -75,11 +76,11 @@ export function _join(items: string[]) {
7576
/**
7677
* Express a list in plain English.
7778
*
78-
* Convert an array of paths to a human-readable sentence listing all the paths. To keep things
79-
* sane, filenames will be used without paths where possible.
79+
* Convert an array of paths to a human-readable sentence listing all the paths.
80+
* To keep things sane, filenames will be used without paths where possible.
8081
*
81-
* Leave order as in comes it - though sorting could be added if needed. Git might already be doing
82-
* some useful sorting.
82+
* Leave order as in comes it - though sorting could be added if needed. Git
83+
* might already be doing some useful sorting.
8384
*/
8485
export function humanList(paths: string[]) {
8586
if (!paths.length) {
@@ -97,7 +98,8 @@ export function humanList(paths: string[]) {
9798
/**
9899
* Determine if a pair of paths represents a move, rename, or both.
99100
*
100-
* TODO: Update to handle case modified in addition to move/rename, or make a new function.
101+
* TODO: Update to handle case modified in addition to move/rename, or make a
102+
* new function.
101103
*/
102104
export function moveOrRenameFromPaths(
103105
oldP: SplitPathResult,

0 commit comments

Comments
 (0)