如何将 scss 文件导入打字稿文件

Posted

技术标签:

【中文标题】如何将 scss 文件导入打字稿文件【英文标题】:How to import a scss file into a typescript file 【发布时间】:2019-10-27 00:42:27 【问题描述】:

我正在尝试将 .scss 文件导入 .tsx 打字稿文件。

但是我收到以下错误。当我运行npm run tsc

src/public/app1/index.tsx:5:20 - 错误 TS2307:找不到模块 './index.scss'。

5 从“./index.scss”导入样式; ~~~~~~~~~~~~~~~~~

发现 1 个错误。

index.tsx

import React from "react";
import  render  from "react-dom";
import App from "./App";
import styles from "./index.scss";

render(
    <App/>,
    document.getElementById("root"),
);

index.scss

body 
    background:red;
    color: #005CC5;
    text-align: center;

我看到一个解决方案是在我的项目的根目录中创建一个 decleration.d.ts 文件。但这对我不起作用。 Can't import CSS/SCSS modules. TypeScript says "Cannot Find Module"

declaration.d.ts

declare module '*.scss';

tsconfig.json


  "compilerOptions": 
    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    "jsx": "react",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./build",                        /* Redirect output structure to the directory. */
    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    "baseUrl": "./src",                       /* Base directory to resolve non-absolute module names. */
    // "paths": ,                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
  ,
  "include": [
    "src",
  ],
  "exclude": [
    "node_modules"
  ]

【问题讨论】:

通常框架会在同一文件夹中找到与您的 TS 文件的名称匹配的 SCSS 文件。你不需要自己导入这个。 什么框架? 如果我有很多 .scss 文件,我需要将它们导入到 react 中才能使用它们。对不起,我误解了你的意思? 你是说我不需要将任何 scss 文件导入到我的 tsx 文件中吗?如果 scss 文件位于子目录中并且我想在位于另一个目录中的 tsx 文件中使用它……或者它们的名称不同怎么办? 是的,我在你的 react 应用程序的 src 中添加了一个 global.d.ts 文件在里面添加 declare module "*.scss"; 【参考方案1】:

作为OP mentioned,当前的解决方案是在您的src 目录中添加一个名为global.d.ts 的文件,其内容如下

declare module '*.scss';

在我的例子中,我使用rollup-plugin-lit-css 将 CSS 导入为 js 对象。我必须创建一个/typings/declarations.d.ts 文件,

declare module '*.css' 
  import  Cs-s-result  from 'lit-element';
  const css: Cs-s-result;
  export default css;

并像这样在 tsconfig 中引用它:


  "include": [ "typings", "src" ],
  "compilerOptions": 
    "target": "ESNext",
    "module": "CommonJS",
    "esModuleInterop": true,
    "noEmit": true,
    "allowJs": true,
    "checkJs": true
  

【讨论】:

以上是关于如何将 scss 文件导入打字稿文件的主要内容,如果未能解决你的问题,请参考以下文章

如何将声音文件导入反应打字稿组件?

如何将图像导入打字稿?他说“找不到模块”

Vue Cli 3 打字稿。无法将 css/sass 导入 <script> 块

打字稿导入文本文件“错误 TS2307:找不到模块”

打字稿:如何在全局范围内进行一些导入?

如何覆盖从打字稿中其他文件导入的功能?