Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
docs/script/find-orphaned-assets.mjs at main · vb2ae/docs · GitHub
Skip to content
Navigation Menu
Sign in
Products
Platform
GitHub
Repository hosting, code review, and collaboration
Copilot
AI coding agent for tasks, projects and automated work
Build & Ship
Actions
CI/CD and automation
Code Quality
Quality analysis, fixes, and enforcement
Codespaces
Cloud development environments
Secure
Code Security
Vulnerability detection and remediation
Secret Protection
Secret scanning and leak prevention
All Features
Developers
Learn
Documentation
Training
Certifications
Build
Build with Copilot
Customize Copilot
Integrations
Explore
Trending repos
GitHub Sponsors
Events
Changelog
Changelog
Your source for the latest features, improvements, and fixes across GitHub products, all in one place.
Businesses
By Stage
Enterprises
Team
Startups
Nonprofits
By Industry
Healthcare
Financial services
Manufacturing
Government
See all industries
Evaluate GitHub
Why GitHub
Customer Stories
Business insights
Trust Center
Add-ons
GitHub Advanced Security
Enterprise-grade code security
Copilot for business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Resources
Learn & Connect
Documentation
Resource center
Blog
Events & webinars
Community Forum
Customer Stories
Integrations
Support
Customer support
Training
GitHub Status
Company
About
Partners
Changelog
GitHub Universe
GitHub Universe
The event for developers, by developers — talks, workshops, and what’s next for GitHub.
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
vb2ae
docs
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
More
items
Files
Expand file tree
main
Breadcrumbs
docs
/
script
/
find-orphaned-assets.mjs
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
executable file
·
135 lines (119 loc) · 3.45 KB
main
Breadcrumbs
docs
/
script
/
find-orphaned-assets.mjs
Copy path
Top
File metadata and controls
Code
Blame
executable file
·
135 lines (119 loc) · 3.45 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
#!/usr/bin/env node
// [start-readme]
//
// Print a list of all the asset files that can't be found mentioned
// in any of the source files (content & code).
//
// [end-readme]
import
fs
from
'fs'
import
path
from
'path'
import
{
program
}
from
'commander'
import
walk
from
'walk-sync'
const
EXCEPTIONS
=
new
Set
(
[
'assets/images/site/favicon.ico'
,
'assets/images/site/apple-touch-icon.png'
,
]
)
function
isExceptionPath
(
imagePath
)
{
// We also check for .DS_Store because any macOS user that has opened
// a folder with images will have this on disk. It won't get added
// to git anyway thanks to our .DS_Store.
// But if we don't make it a valid exception, it can become inconvenient
// to run this script locally.
return
(
EXCEPTIONS
.
has
(
imagePath
)
||
path
.
basename
(
imagePath
)
===
'.DS_Store'
||
imagePath
.
split
(
path
.
sep
)
.
includes
(
'early-access'
)
)
}
program
.
description
(
'Print all images that are in ./assets/ but not found in any source files'
)
.
option
(
'-e, --exit'
,
'Exit script by count of orphans (useful for CI)'
)
.
option
(
'-v, --verbose'
,
'Verbose outputs'
)
.
option
(
'--json'
,
'Output in JSON format'
)
.
option
(
'--exclude-translations'
,
"Don't search in translations/"
)
.
parse
(
process
.
argv
)
main
(
program
.
opts
(
)
,
program
.
args
)
async
function
main
(
opts
)
{
const
{
json
,
verbose
,
exit
,
excludeTranslations
}
=
opts
const
walkOptions
=
{
directories
:
false
,
includeBasePath
:
true
,
}
const
sourceFiles
=
[
]
const
roots
=
[
'content'
,
'data'
,
'tests'
,
'components'
,
'script'
,
'stylesheets'
,
'contributing'
,
'pages'
,
]
if
(
!
excludeTranslations
)
{
roots
.
push
(
'translations'
)
}
for
(
const
root
of
roots
)
{
sourceFiles
.
push
(
...
walk
(
root
,
Object
.
assign
(
{
globs
:
[
'!**/*.+(png|jpe?g|csv|graphql|json|svg)'
]
,
}
,
walkOptions
)
)
)
}
// Add exceptions
sourceFiles
.
push
(
'CONTRIBUTING.md'
)
sourceFiles
.
push
(
'README.md'
)
verbose
&&
console
.
log
(
`
${
sourceFiles
.
length
.
toLocaleString
(
)
}
source files found in total.`
)
const
allImages
=
new
Set
(
walk
(
'assets'
,
Object
.
assign
(
{
globs
:
[
'!**/*.+(md)'
]
,
}
,
walkOptions
)
)
.
filter
(
(
filePath
)
=>
!
filePath
.
endsWith
(
'.md'
)
)
)
verbose
&&
console
.
log
(
`
${
allImages
.
size
.
toLocaleString
(
)
}
images found in total.`
)
for
(
const
sourceFile
of
sourceFiles
)
{
const
content
=
fs
.
readFileSync
(
sourceFile
,
'utf-8'
)
for
(
const
imagePath
of
allImages
)
{
const
needle
=
imagePath
.
split
(
path
.
sep
)
.
slice
(
-
2
)
.
join
(
'/'
)
if
(
content
.
includes
(
needle
)
||
isExceptionPath
(
imagePath
)
)
{
allImages
.
delete
(
imagePath
)
}
}
}
if
(
verbose
&&
allImages
.
size
)
{
console
.
log
(
'The following files are not mentioned anywhere in any source file'
)
}
if
(
json
)
{
console
.
log
(
JSON
.
stringify
(
[
...
allImages
]
,
undefined
,
2
)
)
}
else
{
for
(
const
imagePath
of
[
...
allImages
]
.
sort
(
(
a
,
b
)
=>
a
.
localeCompare
(
b
)
)
)
{
console
.
log
(
imagePath
)
}
}
if
(
verbose
)
{
console
.
log
(
`
${
allImages
.
size
.
toLocaleString
(
)
}
orphans left.`
)
const
totalDiskSize
=
getTotalDiskSize
(
allImages
)
console
.
log
(
`Total disk size of all of these:
${
(
totalDiskSize
/
1024
/
1024
)
.
toFixed
(
1
)
}
MB`
)
}
if
(
exit
)
{
process
.
exit
(
allImages
.
size
)
}
}
function
getTotalDiskSize
(
filePaths
)
{
let
sum
=
0
for
(
const
filePath
of
filePaths
)
{
sum
+=
fs
.
statSync
(
filePath
)
.
size
}
return
sum
}
You can’t perform that action at this time.