mirror of
https://github.com/wasp-lang/wasp.git
synced 2024-09-11 15:26:19 +03:00
Updated instructions for running wasp-migrate script and removed old migrate script.
This commit is contained in:
Martin Sosic
parent
ed684e583f
commit
c46615236d
@ -1,212 +0,0 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const execSync = require('child_process').execSync;
|
||||
|
||||
// This script migrates Wasp 0.11 project to Wasp 0.12.
|
||||
// It doesn't migrate Auth though, that you have to migrate manually.
|
||||
// To run this script, position yourself in the parent dir of your wasp project (so one level above your wasp project), and run:
|
||||
// node migrate-0-11-to-0-12.js <your-wasp-project-dir-name>
|
||||
// Make sure that you have wasp version 0.12 installed.
|
||||
|
||||
// When developing this script, we can set WASP_MIGRATE_DEV to use `wasp-cli` instead of `wasp`, e.g.:
|
||||
// WASP_MIGRATE_DEV=1 node ../waspc/tools/migrate-0-11-to-0-12.js waspello
|
||||
|
||||
// NOTE: If you move the position of this script in this repo, make sure to also update
|
||||
// the instructions in the docs for using it, since they are referring to it directly on the `main` branch.
|
||||
|
||||
const DEV_MODE = process.env['WASP_MIGRATE_DEV'];
|
||||
|
||||
const WASP_BIN = DEV_MODE ? 'wasp-cli' : 'wasp';
|
||||
|
||||
async function migrate() {
|
||||
assertWaspVersion();
|
||||
|
||||
const projectDirName = obtainProjectDirName();
|
||||
|
||||
const mainWaspPath = path.join(projectDirName, 'main.wasp');
|
||||
const wasprootPath = path.join(projectDirName, '.wasproot');
|
||||
const publicDir = path.join(projectDirName, 'public');
|
||||
const srcDir = path.join(projectDirName, 'src');
|
||||
const gitignorePath = path.join(projectDirName, '.gitignore');
|
||||
|
||||
// Check that projectDirName has .wasproot file.
|
||||
if (!fs.existsSync(wasprootPath)) {
|
||||
console.error(`Error: ${projectDirName} is not a wasp project (missing .wasproot file).`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
await printWarning();
|
||||
|
||||
const oldProjectDirName = projectDirName + '__old';
|
||||
const oldPublicDir = path.join(oldProjectDirName, 'src', 'client', 'public');
|
||||
const oldGitignorePath = path.join(oldProjectDirName, '.gitignore');
|
||||
|
||||
{
|
||||
console.log(`1. Renaming ${projectDirName} to ${oldProjectDirName}...`);
|
||||
fs.renameSync(projectDirName, oldProjectDirName);
|
||||
}
|
||||
|
||||
{
|
||||
console.log(`2. Creating new project ${projectDirName}...`);
|
||||
execSync(`${WASP_BIN} new ${projectDirName}`, { stdio: 'inherit' });
|
||||
}
|
||||
|
||||
{
|
||||
console.log(`3. Deleting all files of the ${projectDirName}/src except for vite-env.d.ts...`);
|
||||
fs.readdirSync(srcDir).forEach((file) => {
|
||||
if (file !== 'vite-env.d.ts') {
|
||||
fs.unlinkSync(path.join(srcDir, file));
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
{
|
||||
console.log(`4. Copying public dir from ${oldProjectDirName} to ${projectDirName}...`);
|
||||
if (fs.existsSync(oldPublicDir)) {
|
||||
fs.cpSync(oldPublicDir, publicDir, { recursive: true, overwrite: true });
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
console.log(`5. Copying the contents of ${oldProjectDirName}/src into ${projectDirName}/src...`);
|
||||
fs.cpSync(path.join(oldProjectDirName, 'src'), path.join(projectDirName, 'src'), { recursive: true, overwrite: false });
|
||||
}
|
||||
|
||||
{
|
||||
console.log(`6. Deleting redundant files and folders from ${projectDirName}/src...`);
|
||||
['.waspignore',
|
||||
path.join('client', 'vite-env.d.ts'),
|
||||
path.join('client', 'tsconfig.json'),
|
||||
path.join('server', 'tsconfig.json'),
|
||||
path.join('shared', 'tsconfig.json'),
|
||||
].forEach((filePathInSrc) => {
|
||||
fs.unlinkSync(path.join(srcDir, filePathInSrc));
|
||||
})
|
||||
// Delete client/public if it exists.
|
||||
const publicDirInSrc = path.join(srcDir, 'client', 'public');
|
||||
if (fs.existsSync(publicDirInSrc)) {
|
||||
fs.rmSync(publicDirInSrc, { recursive: true });
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
console.log('7. Updating JS/TS imports from 0.11 to 0.12...');
|
||||
execSync(`npx jscodeshift@0.15.1 -t https://raw.githubusercontent.com/wasp-lang/wasp-codemod/main/src/transforms/imports-from-0-11-to-0-12.ts --extensions=js,ts,jsx,tsx ${srcDir}`, { stdio: 'inherit' });
|
||||
}
|
||||
|
||||
{
|
||||
console.log('8. Copying main.wasp from old project to new project...');
|
||||
fs.copyFileSync(path.join(oldProjectDirName, 'main.wasp'), path.join(projectDirName, 'main.wasp'));
|
||||
}
|
||||
|
||||
{
|
||||
console.log('9. Updating main.wasp (0.11 -> 0.12, @server -> @src/server, @client -> @src/client)...');
|
||||
const mainWaspContent = fs.readFileSync(mainWaspPath, 'utf8');
|
||||
const updatedMainWaspContent = mainWaspContent
|
||||
.replace(/version\s*:\s*"\^0\.11\.\d+"/g, 'version: "^0.12.0"')
|
||||
.replace(/"@server\//g, '"@src/server/')
|
||||
.replace(/"@client\//g, '"@src/client/');
|
||||
fs.writeFileSync(mainWaspPath, updatedMainWaspContent);
|
||||
}
|
||||
|
||||
{
|
||||
console.log('10. Moving the dependencies from main.wasp into package.json...');
|
||||
const mainWaspContent = fs.readFileSync(mainWaspPath, 'utf8');
|
||||
const waspDepsStrMatches = mainWaspContent.match(/(,)?\s*dependencies\s*:\s*\[[^\]]+\]/);
|
||||
if (waspDepsStrMatches) {
|
||||
const waspDepsStr = waspDepsStrMatches[0];
|
||||
const deps = waspDepsStr.match(/\(\s*"[^"]+"\s*,\s*"[^"]+"\s*\)/g).map((depStr) => {
|
||||
const [packageNameStr, versionStr] = depStr.match(/"[^"]+"/g);
|
||||
return {packageNameStr, versionStr};
|
||||
});
|
||||
const updatedMainWaspContent = mainWaspContent.replace(waspDepsStr, '');
|
||||
|
||||
const packageJsonDepsStr = deps.map(({ packageNameStr, versionStr }) => ` ${packageNameStr}: ${versionStr}`).join(',\n');
|
||||
const packageJsonPath = path.join(projectDirName, 'package.json');
|
||||
const packageJsonContent = fs.readFileSync(packageJsonPath, 'utf8');
|
||||
const updatedPackageJsonContent = packageJsonContent.replace(/"dependencies"\s*:\s*\{/, `"dependencies": {\n${packageJsonDepsStr},`);
|
||||
|
||||
fs.writeFileSync(packageJsonPath, updatedPackageJsonContent);
|
||||
fs.writeFileSync(mainWaspPath, updatedMainWaspContent);
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
console.log('11. Merging .gitignore from old project into .gitignore in new project...');
|
||||
if (fs.existsSync(oldGitignorePath)) {
|
||||
const oldGitignoreLines = fs.readFileSync(oldGitignorePath, 'utf8').split('\n');
|
||||
const newGitignoreLines = fs.readFileSync(gitignorePath, 'utf8').split('\n');
|
||||
const linesToAdd = oldGitignoreLines.filter((line) => !newGitignoreLines.includes(line));
|
||||
fs.appendFileSync(gitignorePath, linesToAdd.join('\n'));
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
console.log('12. Copying the rest of relevant top level files and dirs...');
|
||||
fs.readdirSync(oldProjectDirName).forEach((item) => {
|
||||
if (!['.gitignore', 'main.wasp', 'src', '.wasp', '.waspinfo', '.wasproot', 'node_modules'].includes(item)) {
|
||||
const oldItemPath = path.join(oldProjectDirName, item);
|
||||
const newItemPath = path.join(projectDirName, item);
|
||||
if (fs.lstatSync(oldItemPath).isDirectory()) {
|
||||
fs.cpSync(oldItemPath, newItemPath, { recursive: true });
|
||||
} else {
|
||||
fs.copyFileSync(oldItemPath, newItemPath);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
{
|
||||
console.log(`13. Cleaning up (wasp clean, deleting ${oldProjectDirName} dir)...`);
|
||||
execSync(`cd ${projectDirName} && ${WASP_BIN} clean`);
|
||||
execSync(`rm -rf ${oldProjectDirName}`);
|
||||
}
|
||||
|
||||
console.log(
|
||||
'\nAll done! Please inspect the changes we did, ideally with `git diff`, to make sure they make sense.'
|
||||
+ '\nLook out for any TODO comments we might have generated for the JS imports, as those need to be resolved manually.'
|
||||
);
|
||||
}
|
||||
|
||||
function assertWaspVersion() {
|
||||
if (!execSync(`${WASP_BIN} version`).toString().includes('0.12.')) {
|
||||
console.error('Error: Your wasp is not version 0.12.x');
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
function obtainProjectDirName() {
|
||||
const projectDirName = process.argv[2].replace(/\/$/, '');
|
||||
if (projectDirName.split(path.sep).length > 1) {
|
||||
console.error('Error: Please provide the name of the project, not the path.');
|
||||
process.exit(1);
|
||||
}
|
||||
return projectDirName;
|
||||
}
|
||||
|
||||
async function printWarning() {
|
||||
console.log(
|
||||
'This script will modify files on the disk.\nWe strongly recommend you have a'
|
||||
+ ' way to revert them back if needed (e.g. they are version controled (git)).'
|
||||
+ '\nIt will start in 10 seconds...'
|
||||
);
|
||||
if (!DEV_MODE) {
|
||||
await sleep(5000);
|
||||
console.log('5 seconds...');
|
||||
await sleep(5000);
|
||||
}
|
||||
}
|
||||
|
||||
async function sleep(ms) {
|
||||
return new Promise(resolve => setTimeout(resolve, ms));
|
||||
}
|
||||
|
||||
migrate()
|
||||
.then(() => {
|
||||
process.exit(0)
|
||||
})
|
||||
.catch(e => {
|
||||
console.error(e.toString());
|
||||
process.exit(1);
|
||||
});
|
||||
@ -166,7 +166,7 @@ directory `foo`, you should:
|
||||
2. Position yourself in the terminal in the directory that is a parent of your wasp project directory (so one level above: if you do `ls`, you should see your wasp project dir listed).
|
||||
3. Run the migration script (replace `foo` at the end with the name of your Wasp project directory) and follow the instructions:
|
||||
```
|
||||
curl -sSL https://raw.githubusercontent.com/wasp-lang/wasp/main/waspc/tools/migrate-0-11-to-0-12.js | node - foo
|
||||
npx wasp-migrate foo
|
||||
```
|
||||
|
||||
<details>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user