开源项目 `stop-mess-around` 使用教程

开源项目 stop-mess-around 使用教程

stop-mess-around自律chrome浏览器插件：帮助你戒掉上班/学习期间下意识的在浏览器打开知乎等网站的习惯，往往一看就是几个小时过去了，插件会自动检测摸鱼网站, 提示激励信息后, 关闭摸鱼网站。项目地址:https://gitcode.com/gh_mirrors/st/stop-mess-around

1. 项目的目录结构及介绍

stop-mess-around/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config.js
│   ├── utils/
│   │   ├── logger.js
│   │   └── helper.js
│   └── modules/
│       ├── blocker.js
│       └── detector.js
└── test/
    ├── index.test.js
    └── modules/
        ├── blocker.test.js
        └── detector.test.js

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config.js: 项目配置文件。
  • utils/: 工具函数目录。
    • logger.js: 日志记录工具。
    • helper.js: 辅助函数工具。
  • modules/: 功能模块目录。
    • blocker.js: 阻止功能模块。
    • detector.js: 检测功能模块。
• test/: 测试代码目录。
  • index.test.js: 入口文件测试。
  • modules/: 功能模块测试。
    • blocker.test.js: 阻止功能模块测试。
    • detector.test.js: 检测功能模块测试。

2. 项目的启动文件介绍

src/index.js 是项目的启动文件，负责初始化配置和启动主要功能模块。以下是该文件的主要内容：

const config = require('./config');
const blocker = require('./modules/blocker');
const detector = require('./modules/detector');

// 初始化配置
config.init();

// 启动阻止功能
blocker.start();

// 启动检测功能
detector.start();

3. 项目的配置文件介绍

src/config.js 是项目的配置文件，包含项目的各种配置选项。以下是该文件的主要内容：

module.exports = {
  init: function() {
    // 初始化配置
    this.blockSites = ['facebook.com', 'twitter.com'];
    this.logLevel = 'info';
  },
  blockSites: [],
  logLevel: 'info'
};

• blockSites: 需要阻止访问的网站列表。
• logLevel: 日志记录级别，可选值为 info, warn, error。

以上是 stop-mess-around 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

stop-mess-around自律chrome浏览器插件：帮助你戒掉上班/学习期间下意识的在浏览器打开知乎等网站的习惯，往往一看就是几个小时过去了，插件会自动检测摸鱼网站, 提示激励信息后, 关闭摸鱼网站。项目地址:https://gitcode.com/gh_mirrors/st/stop-mess-around