blob: 02289d172a8cdb47e0de4f37370bc6456352544b (
plain) (
blame)
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# INTRO:
# This file is used to build ferdium on windows.
# It also handles any corrupted node modules with the 'CLEAN' env var (set it to 'true' for cleaning)
# It will install the system dependencies except for node and python (which are still verified)
# I sometimes symlink my 'recipes' folder so that any changes that I need to do in it can also be committed and pushed independently
# This file can live anywhere in your PATH
$USERHOME = "${env:HOMEDRIVE}${env:HOMEPATH}"
$env:ELECTRON_CACHE = "$USERHOME\.cache\electron"
$env:ELECTRON_BUILDER_CACHE = "$USERHOME\.cache\electron-builder"
$env:CSC_IDENTITY_AUTO_DISCOVERY = $false
$env:CI = $true
# -----------------------------------------------------------------------------
# Utility functions
Function fail_with_docs {Param ($1)
Write-Host "*************** FAILING ***************"
Write-Host "$1"
Write-Host ""
Write-Host "Please read the developer documentation in CONTRIBUTING.md"
exit 1
}
Function Test-CommandExists { Param ($command, $1)
$oldPreference = $ErrorActionPreference
$ErrorActionPreference = "stop"
try {
if(Get-Command $command){RETURN}
} Catch {
fail_with_docs $1
}
Finally {$ErrorActionPreference=$oldPreference}
}
# -----------------------------------------------------------------------------
# Checking the developer environment
# Check for installed programmes
Test-CommandExists node "Node is not installed"
Test-CommandExists npm "npm is not installed"
# Check node version
$EXPECTED_NODE_VERSION = (cat .nvmrc)
$ACTUAL_NODE_VERSION = (node -v)
if ("v$EXPECTED_NODE_VERSION" -ne $ACTUAL_NODE_VERSION) {
fail_with_docs "You are not running the expected version of node!
expected: [v$EXPECTED_NODE_VERSION]
actual : [$ACTUAL_NODE_VERSION]"
}
# Check if the 'recipes' folder is present either as a git submodule or a symbolic link
if (-not (Test-Path -Path recipes\package.json -PathType Leaf)) {
fail_with_docs "'recipes' folder is missing or submodule has not been checked out"
}
# This log statement is only to remind me which 'recipes' folder I am using (symlink or git submodule)
# TODO: Implement this
# -----------------------------------------------------------------------------
# If you are moving to a new version of node or any other system dependency, then cleaning is recommended
# so that there's no irregular results due to cached modules
if ($env:CLEAN -eq "true")
{
$NPM_PATH = "$USERHOME\AppData\Roaming\npm\node_modules"
$NPM_CACHE1_PATH = "$USERHOME\AppData\Local\npm-cache"
$NPM_CACHE2_PATH = "$USERHOME\AppData\Roaming\npm-cache"
$ELECTRON_GYP = "$USERHOME\.electron-gyp"
Write-Host "Cleaning!"
if ( (Test-Path -Path ".\pnpm-lock.yaml") -and (Get-Command -ErrorAction Ignore -Type Application pnpm) )
{
$PNPM_STORE = "$USERHOME\.pnpm-store"
$PNPM_STATE = "$USERHOME\.pnpm-state"
pnpm store prune
Remove-Item -Path $PNPM_STORE -Recurse -ErrorAction SilentlyContinue
Remove-Item -Path $PNPM_STATE -Recurse -ErrorAction SilentlyContinue
}
npm cache clean --force
Remove-Item -Path $NPM_PATH -Recurse -ErrorAction SilentlyContinue
Remove-Item -Path $NPM_CACHE1_PATH -Recurse -ErrorAction SilentlyContinue
Remove-Item -Path $NPM_CACHE2_PATH -Recurse -ErrorAction SilentlyContinue
Remove-Item -Path $ELECTRON_GYP -Recurse -ErrorAction SilentlyContinue
git -C recipes clean -fxd # Clean recipes folder/submodule
git clean -fxd # Note: This will blast away the 'recipes' folder if you have symlinked it
}
# -----------------------------------------------------------------------------
# Ensure that the system dependencies are at the correct version - fail if not
# Check MSVS Tools through MSVS_VERSION
$EXPECTED_MSVST_VERSION = @("2019","2022")
$NPM_CONFIG_MSVS_VERSION = npm config get msvs_version
if((-not $NPM_CONFIG_MSVS_VERSION) -or -not ($EXPECTED_MSVST_VERSION -contains $NPM_CONFIG_MSVS_VERSION)){
Write-Host "Your Microsoft Visual Studio Tools isn't set properly or it's not the right version!
Checking your version..."
# TODO: Implement path for ARM machines
$MSVS_REG_PATH = "Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\14.0\VC\Runtimes\X64"
if(-not (Test-Path -Path $MSVS_REG_PATH)){
fail_with_docs "You don't have the Microsoft Visual Studio Tools installed!"
}
$MSVS_VERSION = [int]((Get-ItemProperty -Path $MSVS_REG_PATH).Version.substring(4, 2))
switch($MSVS_VERSION) {
{ $MSVS_VERSION -ge 30 } {$ACTUAL_MSVST_VERSION = "2022"}
{ ($MSVS_VERSION -ge 20) -and ($MSVS_VERSION -le 29) } {$ACTUAL_MSVST_VERSION = "2019"}
{ $MSVS_VERSION -lt 20 } {$ACTUAL_MSVST_VERSION = "2017 or lower"}
}
if (-not ($EXPECTED_MSVST_VERSION -contains $ACTUAL_MSVST_VERSION)) {
fail_with_docs "You are not running the expected version of MSVS Tools!
expected: [$EXPECTED_MSVST_VERSION]
actual : [$ACTUAL_MSVST_VERSION]"
}
Write-Host "Changing your msvs_version on npm to [$ACTUAL_MSVST_VERSION]"
npm config set msvs_version $ACTUAL_MSVST_VERSION
}
# -----------------------------------------------------------------------------
# Ensure that the system dependencies are at the correct version - recover if not
# Check pnpm version
$EXPECTED_PNPM_VERSION = (Get-Content package.json | ConvertFrom-Json).engines.pnpm
$ACTUAL_PNPM_VERSION = pnpm --version -ErrorAction SilentlyContinue # in case the pnpm executable itself is not present
if ($ACTUAL_PNPM_VERSION -ne $EXPECTED_PNPM_VERSION) {
npm i -gf pnpm@$EXPECTED_PNPM_VERSION
}
# Check pnpm version of the recipes submodule
$EXPECTED_RECIPES_PNPM_VERSION = (Get-Content .\recipes\package.json | ConvertFrom-Json).engines.pnpm
if ($ACTUAL_PNPM_VERSION -ne $EXPECTED_RECIPES_PNPM_VERSION) {
fail_with_docs "The expected versions of pnpm are not the same in the main repo and in the recipes submodule, please sync them.
expected in recipes : [$EXPECTED_RECIPES_PNPM_VERSION]
expected in main repo: [$EXPECTED_PNPM_VERSION]
actual : [$EXPECTED_PNPM_VERSION]"
}
# -----------------------------------------------------------------------------
Write-Host "*************** Building recipes ***************"
Push-Location recipes
pnpm i && pnpm lint && pnpm reformat-files && pnpm package
Pop-Location
# -----------------------------------------------------------------------------
# Now the meat.....
& pnpm i
& pnpm prepare-code
& pnpm lint
& pnpm test
Write-Host "*************** Building app ***************"
if ($env:PROCESSOR_ARCHITECTURE -eq "ARM64") {
$TARGET_ARCH="arm64"
}
else
{
$TARGET_ARCH="x64"
}
& pnpm build -- --$TARGET_ARCH --dir
Write-Host "*************** App successfully built! ***************"
# Final check to ensure that the version built is the same as the latest commit
$VERSION_BUILT_HASH = (Get-Content build\buildInfo.json | ConvertFrom-Json).gitHashShort
$GIT_BUILT_HASH = (git rev-parse --short HEAD)
if ($VERSION_BUILT_HASH -ne $GIT_BUILT_HASH)
{
Write-Host "The built version is not on the latest commit!"
Write-Host " latest commit : [$GIT_BUILT_HASH]"
Write-Host " actual build : [$VERSION_BUILT_HASH]"
exit 1
}
|
