Code Monkey home page Code Monkey logo

sublimelog's Introduction

SublimeLog

A bare-bones console logger for Sublime Text ~~~~2 and~~~~ 3.

Description

Sublime Text 3 provides a console (accessible via Control-` ) for interaction with the editor's Python-based innards and plug-in architecture. This plug-in logs the console contents into a plain-text file ornamented with logger activation/deactivation timestamps.

The log is erased and recreated each time Sublime Text is launched.

Installation

The most straightforward installation method is by far via Will Bond's superb Package Control. Alternatively, you may clone (or copy the contents of) this repository into your Sublime Text ./Packages folder:

git clone https://github.com/yrammos/SublimeLog.git

Commands

For now SublimeLog supplies a single command that toggles the logger. The default key-binding is Command-Control-C on OS X or Alt-Control-C on Windows/Linux. You may also invoke it via the command palette (โŒ˜-Shift-P on a Mac or Ctrl-Shift-P otherwise): SublimeLog: Toggle logger (on/off)

The key-binding is adjustable in the default JSON file appropriate to your platform:

./Packages/SublimeLog/Default ({OSX | Linux | Windows}).sublime-keymapping

or, to prevent overwrites following plugin updates, in a corresponding file within the User subfolder:

./Packages/User/SublimeLog ({OSX | Linux | Windows}).sublime-keymapping

Retrieving the log

By default, the console is logged in the following plain-text file:

{HOME}/.subl.log

This default destination is adjustable in:

./Packages/SublimeLog/SublimeLog.sublime-settings

or, preferably, in the User subfolder:

./Packages/User/SublimeLog.sublime-settings

Whatever path-filename you declare for the log is relative to your root folder, so please be sure you have adequate write permissions or the plug-in will complain politely.

Note that Sublime Text no longer needs to be restarted for changes to these settings to take effect.

Serving suggestion

I wrote this plug-in as a complement to my LaTeX workflow. Within a dedicated terminal session, or a tmux pane for that matter, I constantly monitor the log file for changes:

tail -f ~/.subl.log

This provides me with a dynamic view of the console stream in a separate window, without the space- and time-consuming tedium of toggling the console view.

If need to maintain a history of log files following successive restarts of the editor, multitail is probably the best solution. It runs on all major Unix platforms and on Windows via Cygwin.

Version history

12/2/2016

  • FIXED: Non-ASCII timestamps no longer cause a crash.
  • NEW: Support for Sublime Text 2 is dropped.

4/18/2013

  • NEW: Support for Sublime Text 3.
  • NEW: Logger may now be toggled via the command palette.
  • NEW: Settings modifications no longer necessitate an editor restart to take effect.

7/17/2012

  • NEW: Adds preferences menu (Sublime Text 2 > Preferences > Package Settings > SublimeLog).
  • FIXED: Default and user preferences are now honored as expected.

6/26/2012

6/22/2012

  • NEW: First release.

Copyright ยฉ 2012-3 by Yannis Rammos. This work is made available under the terms of the Creative Commons Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0) license, http://creativecommons.org/licenses/by-sa/3.0/.

sublimelog's People

Contributors

yrammos avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.