Svelte Persistent Store 项目教程

Svelte Persistent Store 项目教程

svelte-persistent-store A Svelte store that keep its value through pages and reloads 项目地址: https://gitcode.com/gh_mirrors/svel/svelte-persistent-store

1. 项目目录结构及介绍

Svelte Persistent Store 是一个用于 Svelte 的存储库，它可以帮助开发者创建在页面刷新或导航后仍能保持其值的存储。以下是项目的目录结构：

svelte-persistent-store/
├── .github/             # GitHub 工作流和配置文件
│   └── workflows/
├── docs/                # 文档资源
├── src/                 # 源代码目录
│   └── tests/           # 测试文件
├── .editorconfig         # 编辑器配置文件
├── .eslintrc.cjs        # ESLint 配置文件
├── .gitignore           # Git 忽略文件
├── .npmignore           # npm 忽略文件
├── .prettierignore      # Prettier 忽略文件
├── .prettierrc          # Prettier 配置文件
├── CHANGELOG.md         # 更改日志
├── CONTRIBUTING.md      # 贡献指南
├── LICENSE.md           # 许可证文件
├── README.md            # 项目说明文件
├── package-lock.json    # npm 锁定文件
├── package.json         # npm 配置文件
├── rollup.config.mjs    # Rollup 配置文件
├── rollup.test.config.mjs # Rollup 测试配置文件
├── tsconfig.json        # TypeScript 配置文件
└── typedoc.json         # TypeDoc 配置文件

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本来进行的。以下是 package.json 文件中的一些关键启动脚本：

"scripts": {
  "start": "rollup -c -w",
  "build": "rollup -c",
  "test": "jest --passWithNoTests",
  "doc": "typedoc --out docs src"
}

• start: 使用 Rollup 监听文件变化并实时构建项目。
• build: 使用 Rollup 构建项目。
• test: 运行测试脚本。
• doc: 生成项目文档。

3. 项目的配置文件介绍

以下是项目中的重要配置文件及其简要说明：

• .editorconfig: 用于定义代码风格的一致性，如缩进、换行符等。

# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

• .eslintrc.cjs: ESLint 配置文件，用于定义代码质量和风格规则。

module.exports = {
  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
  parserOptions: {
    ecmaVersion: 12,
    sourceType: 'module',
  },
  env: {
    browser: true,
    node: true,
    es2021: true,
  },
  rules: {
    'prettier/prettier': 'error',
  },
};

• .prettierrc: Prettier 配置文件，用于定义代码格式化规则。

{
  "semi": false,
  "singleQuote": true,
  "trailingComma": "es5",
  "printWidth": 80,
  "tabWidth": 2
}

这些配置文件帮助保持代码的一致性和风格，确保项目遵循特定的编码标准。

svelte-persistent-store A Svelte store that keep its value through pages and reloads 项目地址: https://gitcode.com/gh_mirrors/svel/svelte-persistent-store