generator-firefox-extension, 用于 Firefox 扩展的文书生成器

分享于 

5分钟阅读

GitHub

  繁體 雙語
Yeoman generator for Firefox Extensions
  • 源代码名称:generator-firefox-extension
  • 源代码网址:http://www.github.com/dgil/generator-firefox-extension
  • generator-firefox-extension源代码文档
  • generator-firefox-extension源代码下载
  • Git URL:
    git://www.github.com/dgil/generator-firefox-extension.git
    Git Clone代码到本地:
    git clone http://www.github.com/dgil/generator-firefox-extension
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/dgil/generator-firefox-extension
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    Firefox 扩展生成器

    Build Status

    用于扩展扩展的文件生成器允许你使用基本文件结构和推荐设置快速设置扩展。

    这样可以节省编写样板代码的时间,这样就可以立即开始编写项目的逻辑。

    先决条件

    运行这个 Firefox 扩展生成器需要 Firefox add-on SDK。 这里描述了如何安装它: Firefox add-on SDK安装页面。

    如果要使用 grunt-watch,则需要安装扩展自动安装程序。

    正在启动

    安装生成器:

    
    npm install -g generator-firefox-extension
    
    
    
    

    为扩展和 cd 创建一个新目录:

    
    mkdir my-new-firefox-extension && cd $_
    
    
    
    

    运行:yo firefox-extension,可以选择传递扩展名:

    
    yo firefox-extension [extension-name]
    
    
    
    

    有关 Firefox 扩展的更多信息? 请访问 Mozilla开发者网络 add-on。

    文件结构

    Firefox 扩展生成器为你提供完整的项目目录结构:

    
    .
    
    
    ├── Gruntfile.js
    
    
    ├── app
    
    
    │ ├── data
    
    
    │ │ ├── bower_components
    
    
    │ │ ├── contentscript.js
    
    
    │ │ ├── contentstyle.css
    
    
    │ │ ├── images
    
    
    │ │ │ ├── icon-16.png
    
    
    │ │ │ ├── icon-32.png
    
    
    │ │ │ └── icon-64.png
    
    
    │ │ └── popup.html
    
    
    │ ├── lib
    
    
    │ │ └── main.js
    
    
    │ └── package.json
    
    
    ├── bower.json
    
    
    ├── dist
    
    
    └── package.json
    
    
    
    

    测试你的扩展

    若要测试生成的扩展,请运行 grunt run。 将启动带有测试扩展插件的新浏览器。

    构建你的扩展

    若要生成生成的扩展,请运行 jpm xpi --addon-dir=app。 这里命令将创建一个 xpi 文件,你可以分发或者上传到 mozilla add-ons 知识库( AMO )。 或者,可以运行 grunt build,它将在 dist 文件夹中创建 xpi 文件。

    有关提交扩展到AMO的更多信息可以在这里找到: 向AMO提交一个 add-on。

    任务

    运行

    这个grunt任务运行了 Firefox的新实例,并安装了 add-on。 当 Firefox 启动时,在浏览器的右上角,你将看到一个带有 Firefox logo的icon。 如果将弹出选项设置为 true 并单击 icon,则会看到一个带有 hello world 消息的弹出窗口。

     
    grunt run
    
    
    
     

    手表

    这里任务将监视 app 文件夹(。扩展文件的位置是) 中的任何更改,并在 Firefox 中自动重新加载扩展。

     
    grunt watch
    
    
    
     

    记住:为了使用这个功能,你需要安装扩展自动安装插件,并运行 Firefox。

    Wiredep

    这里任务查找 Bower 组件并直接将它们注入到你指定的HTML文件中。

     
    grunt wiredep
    
    
    
     

    插件生成

    这里任务生成 xpi 文件并将它的放入 dist 文件夹中。

     
    grunt build
    
    
    
     

    命令行选项

    • --skip-install

      完成脚手架完成后,跳过 bowernpm的自动执行。

    许可证

    © Casadevall


    相关文章