Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 3.4 KB

README.markdown

File metadata and controls

83 lines (58 loc) · 3.4 KB
Raw

Seacrest

DESCRIPTION:

A collection of tools for web masters, designers and developers to create and maintain a semantic and healthy codebase

FEATURES/PROBLEMS:

  • Need to implement last modified optional for Sitemap Generator
  • CSScrubber needs to not be file agnostic; right now everything's ending up in the unused selectors list.

TODO:

Build the following

  • Identify broken URLs (internal, external and resources)
  • Identify any duplicate META descriptions
  • Identify missing headings from document structure
  • Identify duplicate page titles
  • Find orphaned IDs and classes declared in any CSS files but no longer in use in your HTML files
  • Find orphaned images no longer being called from HTML/CSS
  • Generate a Google Sitemap
  • The command line interface would allow you to run the entire suite or each tool individually via triggers.

General TODO's:

  • Need a general utilities file/class/whatever
  • Extract "traverse" method out from the duplicated locations (currently code is used in both CSScrubber and the Sitemap Generator)
CSScrubber
  • Should work more like a Lint-style tool, at least the reporting aspects of it
Need to haves
  • Find CSS files linked within HTML files (may not live inside a known directory) ??? -> may be moot with proper directory traversal
  • Traverse a live site and compare the files with one another
  • Use something like webrat to spin up a localized version of an application (rails, sinatra, etc) and parse the files
  • Parse SASS/SCSS files
Nice to haves
  • Pre-load all possible selectors from the HTML file
  • Find a way to know what selectors are being used in an HTML file, even if they're not listed in the CSS file.
  • Add the ability to ignore known frameworks (960.gs, blueprint.css, etc) or the ability to include these if they are ignored by default

SYNOPSIS:

None yet

REQUIREMENTS:

  • csspool (~> 0.2.6)
  • Nokogiri (~> 1.3.1.20090611092310)

NOTE: This is ONLY tested against csspool version 0.2.6. It is, however, known to not work with 2.0.0. A fix is in the works for this, but at current it will not run if anything newer than version 0.2.6 is installed.

INSTALL:

No installer yet ... will probably be a gem at some point.

LICENSE:

(The MIT License)

Copyright (c) 2009-2011 Matthew Anderson, Brandon Caplan and Michael Tierney

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.