1 of 13

Actool

Toolkit for code / comments actuality and relevance checking.

// IDEA: Actool

2 of 13

Team

// IDEA: Actool

3 of 13

"Code never lies, comments sometimes do." - Ron Jeffries

// IDEA: Actool

4 of 13

Actool Idea

Toolkit for code / comments actuality and relevance checking.

// IDEA: Actool

5 of 13

Problems

// IDEA: Actool

6 of 13

Lose actuality

Comments for code block loses their actuality fastly - during developing (becomes irrelevant)

// IDEA: Actool

// IDEA: Actool

7 of 13

Stay commented

Sometimes few parts of code stay commented. And after long time this fragment might be confusing

// IDEA: Actool

// IDEA: Actool

8 of 13

TODOs chaos

After a while of your projects started - there are a lot of fixme/todo tags, what hard to control and track during dev

// IDEA: Actool

// IDEA: Actool

9 of 13

Solution && Implementation

Toolkit for JS based on:

  • Git history
  • Config
  • Code Mutations

// IDEA: Actool

10 of 13

Current progress

// IDEA: Actool

11 of 13

Plans Functionality

  • Check comments actuality (with validate triggering by related code changing)
  • Control rubbish commented code (to reduce amount of unused commented and confusing logic)
  • Control todo/fixme's progression (to regulate and normalize project backlog)
  • Notifications for user (for manual checking confusing specified files)

// IDEA: Actool

12 of 13

Plans Variations

  • MVP version for JS�(as script validator)
  • NPM module version for js
  • Version with precommit hook validating
  • ESLint rule
  • Version for IDEs �(at start - vscode extension)
  • Version for other langs

// IDEA: Actool

13 of 13

https://github.com/martis-git/actool-cli

// IDEA: Actool