无法导入CSS / SCSS模块。TypeScript说“找不到模块”


82

我正在尝试从CSS模块导入主题,但是TypeScript给我一个“找不到模块”错误,并且该主题未在运行时应用。我认为Webpack配置有问题,但是我不确定问题出在哪里。

我正在使用以下工具:

"typescript": "^2.0.3"
"webpack": "2.1.0-beta.25"
"webpack-dev-server": "^2.1.0-beta.9"
"react": "^15.4.0-rc.4"
"react-toolbox": "^1.2.3"
"node-sass": "^3.10.1"
"style-loader": "^0.13.1"
"css-loader": "^0.25.0"
"sass-loader": "^4.0.2"
"sass-lint": "^1.9.1"
"sasslint-webpack-plugin": "^1.0.4"

这是我的 webpack.config.js

var path = require('path');
var webpack = require('webpack');
var sassLintPlugin = require('sasslint-webpack-plugin');

module.exports = {
  entry: [
    'webpack-dev-server/client?http://localhost:8080',
    'webpack/hot/dev-server',
    './src/index.tsx',
  ],
  output: {
    path: path.resolve(__dirname, 'dist'),
    publicPath: 'http://localhost:8080/',
    filename: 'dist/bundle.js',
  },
  devtool: 'source-map',
  resolve: {
    extensions: ['.webpack.js', '.web.js', '.ts', '.tsx', '.js'],
  },
  module: {
    rules: [{
      test: /\.js$/,
      loader: 'source-map-loader',
      exclude: /node_modules/,
      enforce: 'pre',
    }, {
      test: /\.tsx?$/,
      loader: 'tslint-loader',
      exclude: /node_modules/,
      enforce: 'pre',
    }, {
      test: /\.tsx?$/,
      loaders: [
        'react-hot-loader/webpack',
        'awesome-typescript-loader',
      ],
      exclude: /node_modules/,
    }, {
      test: /\.scss$/,
      loaders: ['style', 'css', 'sass']
    }, {
      test: /\.css$/,
      loaders: ['style', 'css']
    }],
  },
  externals: {
    'react': 'React',
    'react-dom': 'ReactDOM'
  },
  plugins: [
    new sassLintPlugin({
      glob: 'src/**/*.s?(a|c)ss',
      ignoreFiles: ['src/normalize.scss'],
      failOnWarning: false, // Do it.
    }),
    new webpack.HotModuleReplacementPlugin(),
  ],
  devServer: {
    contentBase: './'
  },
};

和我App.tsx要导入的位置:

import * as React from 'react';

import { AppBar } from 'react-toolbox';
import appBarTheme from 'react-toolbox/components/app_bar/theme.scss'
// local ./theme.scss stylesheets aren't found either 

interface IAppStateProps {
  // No props yet
}

interface IAppDispatchProps {
  // No state yet
}

class App extends React.Component<IAppStateProps & IAppDispatchProps, any> {

  constructor(props: IAppStateProps & IAppDispatchProps) {
    super(props);
  }

  public render() {
    return (

        <div className='wrapper'>
          <AppBar title='My App Bar' theme={appBarTheme}>
          </AppBar>
        </div>

    );
  }
}

export default App;

启用类型安全样式表模块导入还需要什么?

Answers:


120

TypeScript不知道除以外的文件.ts.tsx因此如果导入文件后缀未知,它将引发错误。

如果您有一个webpack配置允许导入其他类型的文件,则必须告诉TypeScript编译器这些文件存在。为此,添加一个声明文件,在其中声明具有合适名称的模块。

要声明的模块的内容取决于用于文件类型的webpack加载器。在*.scss通过sass-loadercss-loaderstyle-loader通过管道传输文件的Webpack配置中,导入的模块中将没有内容,并且正确的模块声明应如下所示:

// declaration.d.ts
declare module '*.scss';

如果为css-modules配置了加载程序,则只需扩展声明,如下所示:

// declaration.d.ts
declare module '*.scss' {
    const content: {[className: string]: string};
    export default content;
}

1
嘿,这对我不起作用,最近发生了一些变化。 stackoverflow.com/questions/56563243/…–

45

这是一个对我有用的完整配置(我只是花了一个小时痛苦的反复试验,以防有人遇到相同的问题):

TypeScript + WebPack + Sass

webpack.config.js

module.exports = {
  //mode: "production", 
    mode: "development", devtool: "inline-source-map",

    entry: [ "./src/app.tsx"/*main*/ ], 
    output: {
        filename: "./bundle.js"  // in /dist
    },
    resolve: {
        // Add `.ts` and `.tsx` as a resolvable extension.
        extensions: [".ts", ".tsx", ".js", ".css", ".scss"]
    },
    module: {
        rules: [

            { test: /\.tsx?$/, loader: "ts-loader" }, 

            { test: /\.scss$/, use: [ 
                { loader: "style-loader" },  // to inject the result into the DOM as a style block
                { loader: "css-modules-typescript-loader"},  // to generate a .d.ts module next to the .scss file (also requires a declaration.d.ts with "declare modules '*.scss';" in it to tell TypeScript that "import styles from './styles.scss';" means to load the module "./styles.scss.d.td")
                { loader: "css-loader", options: { modules: true } },  // to convert the resulting CSS to Javascript to be bundled (modules:true to rename CSS classes in output to cryptic identifiers, except if wrapped in a :global(...) pseudo class)
                { loader: "sass-loader" },  // to convert SASS to CSS
                // NOTE: The first build after adding/removing/renaming CSS classes fails, since the newly generated .d.ts typescript module is picked up only later
            ] }, 

        ]
    }
}; 

还要declarations.d.ts在您的项目中添加一个:

// We need to tell TypeScript that when we write "import styles from './styles.scss' we mean to load a module (to look for a './styles.scss.d.ts'). 
declare module '*.scss'; 

您将在package.jsondev-dependencies中需要所有这些:

  "devDependencies": {
    "@types/node-sass": "^4.11.0",
    "node-sass": "^4.12.0",
    "css-loader": "^1.0.0",
    "css-modules-typescript-loader": "^2.0.1",
    "sass-loader": "^7.1.0",
    "style-loader": "^0.23.1",
    "ts-loader": "^5.3.3",
    "typescript": "^3.4.4",
    "webpack": "^4.30.0",
    "webpack-cli": "^3.3.0"
  }

然后,您应该mystyle.d.tsmystyle.scss包含您定义的CSS类的旁边,您可以将其作为Typescript模块导入并像这样使用:

import * as styles from './mystyles.scss'; 

const foo = <div className={styles.myClass}>FOO</div>; 

CSS将被自动加载(作为style元素插入DOM)并包含隐式标识符,而不是.scss中的CSS类,以隔离页面中的样式(除非您使用:global(.a-global-class) { ... })。

请注意,无论何时添加CSS类或删除它们或重命名它们,第一次编译都会失败,因为导入的mystyles.d.ts是旧版本,而不是编译期间刚刚生成的新版本。只是再次编译。

请享用。


“注意:添加/删除/重新命名CSS类之后的第一个构建失败,因为新生成的.d.ts打字稿模块只能在以后使用。”-如何解决该问题?
Jon Lauridsen

3
@JonLauridsen,可以通过在webpack.config.js中规则数组的底部(末端)设置ts-loader来解决。因此,由于每次编译之前ts-loader都会生成正确的* .scss.d.ts文件,因此它们会被生成。
Yan Pak

1
@YanPak谢谢,将ts-loader添加global.d.ts到我的src目录中,然后将ts-loader移动到样式加载器下面,为我修复了它。
勒克斯

4

如果使用tsconfig.json路径设置,请注意

请注意,如果将这些解决方案与tsconfig路径结合使用以缩短导入时间,则将需要其他配置。

如果碰巧使用如下路径tsconfig:

{
  "compilerOptions": {
    "paths": {
      "style/*": [ "src/style/*" ],
    }
  }
}

因此,您可以执行以下操作:

import { header } from 'style/ui.scss';

然后,您还需要在webpack上添加一个模块来解析配置,例如:

module.exports = {
  ...
  resolve: {
    ...
    alias: {
      style: path.resolve(__dirname, 'src', 'style')
    }
  }
}

确保根据您的设置设置了路径。

这使webpack知道要查找的位置,因为它认为新的导入路径实际上是一个模块,因此默认为node_modules目录。使用此配置,它知道在哪里寻找并找到它,并且构建成功。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.