Ember Shepherd 使用教程

欢迎来到 Ember Shepherd 的详细指南，这是一个专为 Ember.js 应用设计的站点导览库插件。本教程旨在帮助您了解项目的基本结构、关键文件以及如何进行基本配置。

1. 项目目录结构及介绍

ember-shepherd 的目录遵循了 Ember CLI 项目的常规组织结构，以下是一些核心组件和它们的功能：

• app: 此目录包含了应用程序的主要代码，包括组件、控制器、模型、路由和服务等。

  • instance-initializers: FastBoot 期间初始化实例所需的代码。
  • services: 包含服务定义，如与 Shepherd 导览功能相关的服务。

• tests: 单元测试和集成测试存放的位置。

  • 测试你的组件、服务等是否按预期工作。

• config: 存放配置文件的地方，主要文件是 environment.js，用于根据环境（开发、测试、生产）调整应用设置。

• .editorconfig, .eslintignore, .eslintrc.js, .gitignore, .prettierrc.js, etc.: 这类文件用于代码风格统一和版本控制设置。

• ember-cli-build.js: 构建配置文件，定义了如何构建你的应用，包括加载的插件和编译规则。

• package.json, yarn.lock: 依赖管理文件，列出所有npm或yarn包及其版本。

• README.md, LICENSE.md: 分别提供了快速入门指南、许可信息。

2. 项目的启动文件介绍

在 Ember 应用中，虽然没有一个单一的“启动文件”，但 ember serve 命令会触发一系列进程，其中重要的是 ember-cli-build.js 文件。这个文件配置了 Webpack 或 Broccoli 构建流程，定义了应用程序的入口点（默认是 app/application.js），并引入必要的构建插件和设置。要启动开发服务器，您只需运行此命令，Ember CLI 将处理余下的构建和启动逻辑。

ember serve

3. 项目的配置文件介绍

environment.js

位于 config/environment.js 的配置文件是 Ember 应用程序中最重要的配置中心。它允许您根据不同环境（例如开发、测试和生产）来定制配置选项。对于 ember-shepherd 来说，如果您需要对其进行特定环境的配置，可以通过修改该文件中的相应环境对象来实现。例如，您可以添加 Shepherd 的API设置或自定义行为，尽管具体的配置项需参考最新的文档，因为这些细节可能会随版本更新而变化。

module.exports = function(environment) {
  let ENV = {
    modulePrefix: 'my-app',
    environment,
    ...
    // 假设有 Shepherd 特定的配置，这里将是示例位置
    // shepherd: {
    //   // 示例配置
    // },
    ...
  };

  if (environment === 'development') {
    // 开发环境特有配置
  }

  return ENV;
};

请注意，具体配置项需要参照 ember-shepherd 的官方文档，以确保正确应用到您的项目中。记住，保持与项目文档同步至关重要，以便充分利用其最新功能并避免潜在的兼容性问题。