Skip to content

replace unnecessary callback functions with async/await #4555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 24, 2022
Merged

replace unnecessary callback functions with async/await #4555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2bcc424
replace necessary async functions with async/await
Apr 20, 2022
d1e48ab
Merge branch 'main' into improveCode
Apr 21, 2022
d9a6fed
Merge branch 'main' into improveCode
Apr 22, 2022
667ac42
Merge branch 'main' into improveCode
Apr 23, 2022
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
120 changes: 51 additions & 69 deletions build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

const fs = require('fs');
const gracefulFs = require('graceful-fs');

// This is needed at least on Windows to prevent the `EMFILE: too many open files` error
// https://github.com/isaacs/node-graceful-fs#global-patching
gracefulFs.gracefulify(fs);
Expand Down Expand Up @@ -268,7 +269,7 @@ function withPreserveLocale(preserveLocale) {
}

// This function builds the static/css folder for all the Sass files.
function buildCSS() {
async function buildCSS() {
console.log('[sass] static/css started');
const labelForBuild = '[sass] static/css finished';
console.time(labelForBuild);
Expand All @@ -277,88 +278,70 @@ function buildCSS() {
const dest = path.join(__dirname, 'build/static/css/styles.css');

const sassOpts = {
file: src,
outFile: dest,
outputStyle:
process.env.NODE_ENV !== 'development' ? 'compressed' : 'expanded'
};

gracefulFs.mkdir(
path.join(__dirname, 'build/static/css'),
{ recursive: true },
(err) => {
if (err) {
throw err;
}

sass.render(sassOpts, (error, result) => {
if (error) {
throw error;
}
const graceFulFsPromise = gracefulFs.promises;

postcss([autoprefixer])
.process(result.css, { from: src })
.then((res) => {
res.warnings().forEach((warn) => {
console.warn(warn.toString());
});
await graceFulFsPromise.mkdir(path.join(__dirname, 'build/static/css'), {
recursive: true
});

gracefulFs.writeFile(dest, res.css, (err) => {
if (err) {
throw err;
}
const result = await sass.compileAsync(src, sassOpts);

console.timeEnd(labelForBuild);
});
});
postcss([autoprefixer])
.process(result.css, { from: src })
.then(async (res) => {
res.warnings().forEach((warn) => {
console.warn(warn.toString());
});
}
);

await graceFulFsPromise.writeFile(dest, res.css);
console.timeEnd(labelForBuild);
});
}

// This function copies the rest of the static assets to their subfolder in the
// build directory.
function copyStatic() {
async function copyStatic() {
console.log('[ncp] build/static started');
const labelForBuild = '[ncp] build/static finished';
console.time(labelForBuild);
gracefulFs.mkdir(

const graceFulFsPromise = gracefulFs.promises;

await graceFulFsPromise.mkdir(path.join(__dirname, 'build/static'), {
recursive: true
});

ncp(
path.join(__dirname, 'static'),
path.join(__dirname, 'build/static'),
{ recursive: true },
(err) => {
if (err) {
throw err;
(error) => {
if (error) {
return console.error(error);
}

ncp(
path.join(__dirname, 'static'),
path.join(__dirname, 'build/static'),
path.join(__dirname, 'node_modules/jquery/dist/jquery.min.js'),
path.join(__dirname, 'build/static/js/jquery.min.js'),
(error) => {
if (error) {
return console.error(error);
}

ncp(
path.join(__dirname, 'node_modules/jquery/dist/jquery.min.js'),
path.join(__dirname, 'build/static/js/jquery.min.js'),
path.join(
__dirname,
'node_modules/jquery.fancytable/dist/fancyTable.min.js'
),
path.join(__dirname, 'build/static/js/fancyTable.min.js'),
(error) => {
if (error) {
return console.error(error);
}

ncp(
path.join(
__dirname,
'node_modules/jquery.fancytable/dist/fancyTable.min.js'
),
path.join(__dirname, 'build/static/js/fancyTable.min.js'),
(error) => {
if (error) {
return console.error(error);
}
console.timeEnd(labelForBuild);
}
);
console.timeEnd(labelForBuild);
}
);
}
Expand Down Expand Up @@ -398,25 +381,24 @@ function getSource(callback) {
// name. It brings together all build steps and dependencies and executes them.
function fullBuild(opts) {
const { selectedLocales, preserveLocale } = opts;
getSource((err, source) => {
getSource(async (err, source) => {
if (err) {
throw err;
}

// Executes the build cycle for every locale.
gracefulFs.readdir(path.join(__dirname, 'locale'), (e, locales) => {
if (e) {
throw e;
}
const filteredLocales = locales.filter(
(file) =>
junk.not(file) &&
(selectedLocales ? selectedLocales.includes(file) : true)
);
const localesData = generateLocalesData(filteredLocales);
filteredLocales.forEach((locale) => {
buildLocale(source, locale, { preserveLocale, localesData });
});
const graceFulFsPromise = gracefulFs.promises;
const locales = await graceFulFsPromise.readdir(
path.join(__dirname, 'locale')
);

const filteredLocales = locales.filter(
(file) =>
junk.not(file) &&
(selectedLocales ? selectedLocales.includes(file) : true)
);
const localesData = generateLocalesData(filteredLocales);
filteredLocales.forEach((locale) => {
buildLocale(source, locale, { preserveLocale, localesData });
});
});
}
Expand Down
31 changes: 14 additions & 17 deletions server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// The server where the site is exposed through a static file server
// while developing locally.

const fs = require('fs');
const fs = require('fs/promises');
const http = require('http');
const path = require('path');
const chokidar = require('chokidar');
Expand Down Expand Up @@ -48,45 +48,42 @@ function getLocale(filePath) {
// This function has two meanings:
// 1. Build for the specific language.
// 2. Choose what languages for the menu.
function dynamicallyBuildOnLanguages(source, locale) {
async function dynamicallyBuildOnLanguages(source, locale) {
let localesData = null;

if (!selectedLocales || selectedLocales.length === 0) {
fs.readdir(path.join(__dirname, 'locale'), (err, locales) => {
if (err) {
throw err;
}

const filteredLocales = locales.filter((file) => junk.not(file));
const localesData = build.generateLocalesData(filteredLocales);
build.buildLocale(source, locale, { preserveLocale, localesData });
});
const localesPath = path.join(__dirname, 'locale');
const locales = await fs.readdir(localesPath);
const filteredLocales = locales.filter((file) => junk.not(file));
localesData = build.generateLocalesData(filteredLocales);
} else {
const localesData = build.generateLocalesData(selectedLocales);
build.buildLocale(source, locale, { preserveLocale, localesData });
localesData = build.generateLocalesData(selectedLocales);
}
build.buildLocale(source, locale, { preserveLocale, localesData });
}

build.getSource((err, source) => {
if (err) {
throw err;
}

locales.on('change', (filePath) => {
locales.on('change', async (filePath) => {
const locale = getLocale(filePath);

if (!selectedLocales || selectedLocales.includes(locale)) {
console.log(
`The language ${locale} is changed, '${filePath}' is modified.`
);
dynamicallyBuildOnLanguages(source, locale);
await dynamicallyBuildOnLanguages(source, locale);
}
});

locales.on('add', (filePath) => {
locales.on('add', async (filePath) => {
const locale = getLocale(filePath);

if (!selectedLocales || selectedLocales.includes(locale)) {
console.log(`The language ${locale} is changed, '${filePath}' is added.`);
dynamicallyBuildOnLanguages(source, locale);
await dynamicallyBuildOnLanguages(source, locale);
locales.add(filePath);
}
});
Expand Down