ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Not that useless project report

by pererinha ST3

A sublime plugin

Labels report

Details

  • 2014.06.02.22.20.27
  • github.​com
  • github.​com
  • 10 years ago
  • 51 minutes ago
  • 10 years ago

Installs

  • Total 472
  • Win 233
  • Mac 121
  • Linux 118
Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

NotThatUselessProjectReport

The idea of this plugin is generate a text file with some info about the current open folder or project. By some info I mean the total of files the folder has, the types of files and how much lines of code each type have. It doesn't read binary files, they are totally ignored by the plugin.

I know it is not the most useful information you can have about your project, but I is something cool to know. At least I think it is cool.

I hope you you find this plugin helpful.

Installation

You can install via Sublime Package Control plugin. Just open “Package Control: Install Package” in your Command Palette and search for “Not That Useless Project Report”.

For manual installation, run the following script in the Sublime Text terminal (ctrl+`) which utilizes git clone.

import os; path=sublime.packages_path(); (os.makedirs(path) if not os.path.exists(path) else None); window.run_command('exec', {'cmd': ['git', 'clone', 'https://github.com/pererinha/NotThatUselessProjectReport', 'NotThatUselessProjectReport'], 'working_dir': path})

It is currently working just for Sublime 3

Usage

  • On Mac Command + Shift + U
  • On Windows or Linux Ctrl + Shift + U

Or

Ctrl + Shift + P and search for “Generate a not useless report about your project”

Example of a report

This is the report of this project

Project report
==============

Summary
-------
|--------------------|--------------------|--------------------|--------------------|
| Type               | Files              | Lines              | Blank lines        |
|--------------------|--------------------|--------------------|--------------------|
| JSON               | 1                  | 4                  | 0                  |
| PY                 | 4                  | 279                | 52                 |
| SUBLIME-COMMANDS   | 1                  | 6                  | 0                  |
| SUBLIME-KEYMAP     | 3                  | 9                  | 0                  |
| TXT                | 2                  | 11                 | 4                  |
|--------------------|--------------------|--------------------|--------------------|

Totals
------
|--------------------|--------------------|--------------------|--------------------|
| Types              | Files              | Lines              | Blank lines        |
|--------------------|--------------------|--------------------|--------------------|
| 5                  | 11                 | 309                | 56                 |
|--------------------|--------------------|--------------------|--------------------|

How cool is that??

Thanks

Special thanks to @joshearl for his awesome book Writing Sublime Plugins and to Audrey Roy for binaryornot, it saved me a lot of time.