Skip to content

Use JSDoc imports instead of unused runtime imports #1314

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.

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 1 commit into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const webpack = require('webpack'); // eslint-disable-line no-unused-vars
/**
* @import webpack from 'webpack'
*/

const EncoreProxy = require('./lib/EncoreProxy');
const WebpackConfig = require('./lib/WebpackConfig');
const configGenerator = require('./lib/config-generator');
Expand Down
5 changes: 4 additions & 1 deletion lib/WebpackConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@

'use strict';

/**
* @import RuntimeConfig from './config/RuntimeConfig'
*/

const path = require('path');
const fs = require('fs');
const crypto = require('crypto');
const RuntimeConfig = require('./config/RuntimeConfig'); //eslint-disable-line no-unused-vars
const logger = require('./logger');
const regexpEscaper = require('./utils/regexp-escaper');
const { calculateDevServerUrl } = require('./config/path-util');
Expand Down
5 changes: 4 additions & 1 deletion lib/config-generator.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('./WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from './WebpackConfig'
*/

const cssExtractLoaderUtil = require('./loaders/css-extract');
const pathUtil = require('./config/path-util');
const featuresHelper = require('./features');
Expand Down
10 changes: 8 additions & 2 deletions lib/config/path-util.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@

'use strict';

/**
* @import WebpackConfig from '../WebpackConfig'
*/

/**
* @import RuntimeConfig from './RuntimeConfig'
*/

const path = require('path');
const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
const RuntimeConfig = require('./RuntimeConfig'); //eslint-disable-line no-unused-vars
const logger = require('../logger');

module.exports = {
Expand Down
5 changes: 4 additions & 1 deletion lib/config/validator.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@

'use strict';

/**
* @import WebpackConfig from '../WebpackConfig'
*/

const pathUtil = require('./path-util');
const logger = require('./../logger');
const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars

class Validator {
/**
Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/babel.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/css-extract.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/css.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/handlebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/less.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const cssLoader = require('./css');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/sass.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const cssLoader = require('./css');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/stylus.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const cssLoader = require('./css');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/typescript.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const babelLoader = require('./babel');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/loaders/vue.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const loaderFeatures = require('../features');
const applyOptionsCallback = require('../utils/apply-options-callback');
const getVueVersion = require('../utils/get-vue-version');
Expand Down
10 changes: 8 additions & 2 deletions lib/plugins/asset-output-display.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,14 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
const FriendlyErrorsWebpackPlugin = require('@nuxt/friendly-errors-webpack-plugin'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

/**
* @import FriendlyErrorsWebpackPlugin from '@nuxt/friendly-errors-webpack-plugin'
*/

const pathUtil = require('../config/path-util');
const AssetOutputDisplayPlugin = require('../friendly-errors/asset-output-display-plugin');
const PluginPriorities = require('./plugin-priorities');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/clean.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const { CleanWebpackPlugin } = require('clean-webpack-plugin');
const PluginPriorities = require('./plugin-priorities');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/define.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@

'use strict';

/**
* @import WebpackConfig from '../WebpackConfig'
*/

const webpack = require('webpack');
const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
const PluginPriorities = require('./plugin-priorities');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/delete-unused-entries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const DeleteUnusedEntriesJSPlugin = require('../webpack/delete-unused-entries-js-plugin');
const PluginPriorities = require('./plugin-priorities');
const copyEntryTmpName = require('../utils/copyEntryTmpName');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/entry-files-manifest.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const PluginPriorities = require('./plugin-priorities');
const copyEntryTmpName = require('../utils/copyEntryTmpName');
const AssetsPlugin = require('assets-webpack-plugin');
Expand Down
7 changes: 5 additions & 2 deletions lib/plugins/forked-ts-types.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); // eslint-disable-line
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
const PluginPriorities = require('./plugin-priorities');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/friendly-errors.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const FriendlyErrorsWebpackPlugin = require('@nuxt/friendly-errors-webpack-plugin');
const missingCssFileTransformer = require('../friendly-errors/transformers/missing-css-file');
const missingCssFileFormatter = require('../friendly-errors/formatters/missing-css-file');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/manifest.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const { WebpackManifestPlugin } = require('../webpack-manifest-plugin');
const PluginPriorities = require('./plugin-priorities');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/mini-css-extract.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const PluginPriorities = require('./plugin-priorities');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/notifier.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const pluginFeatures = require('../features');
const PluginPriorities = require('./plugin-priorities');
const applyOptionsCallback = require('../utils/apply-options-callback');
Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/optimize-css-assets.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/terser.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const TerserPlugin = require('terser-webpack-plugin');
const applyOptionsCallback = require('../utils/apply-options-callback');

Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/variable-provider.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const webpack = require('webpack');
const PluginPriorities = require('./plugin-priorities');

Expand Down
5 changes: 4 additions & 1 deletion lib/plugins/vue.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const PluginPriorities = require('./plugin-priorities');

/**
Expand Down
5 changes: 4 additions & 1 deletion lib/utils/get-vue-version.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

const packageHelper = require('../package-helper');
const semver = require('semver');
const logger = require('../logger');
Expand Down
4 changes: 3 additions & 1 deletion lib/utils/manifest-key-prefix-helper.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@

'use strict';

const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
/**
* @import WebpackConfig from '../WebpackConfig'
*/

/**
* Helper for determining the manifest.json key prefix.
Expand Down