Make company headings consistent (#407)

* Change "Office Locations" to "Office locations" for consistent casing * Standardize other company headings * Validate heading names * Add a way to look at headings of all profiles at once
remoteintech · Apr 16, 2018 · c006350 · c006350
1 parent 4eb1208
commit c006350
Show file tree

Hide file tree

Showing 188 changed files with 266 additions and 210 deletions.
diff --git a/bin/validate.js b/bin/validate.js
@@ -19,6 +19,22 @@ const contentPath = (
 );
 
 
+/**
+ * Define the heading names expected in company profiles.
+ */
+const headingsRequired = [
+	'Company blurb',
+];
+const headingsOptional = [
+	'Company size',
+	'Remote status',
+	'Region',
+	'Company technologies',
+	'Office locations',
+	'How to apply',
+];
+
+
 /**
  * Build list of Markdown files containing company profiles.
  */
@@ -126,6 +142,8 @@ $( 'tr' ).each( ( i, tr ) => {
  * Scan the individual Markdown files containing the company profiles.
  */
 
+const allProfileHeadings = {};
+
 profileFilenames.forEach( filename => {
 	function error( msg, ...params ) {
 		errorCount++;
@@ -181,8 +199,52 @@ profileFilenames.forEach( filename => {
 	) {
 		error( 'No link to company profile from readme' );
 	}
+
+	// Build and validate list of headings contained in this Markdown profile.
+
+	const profileHeadings = [];
+
+	$( 'h2' ).each( ( i, el ) => {
+		const headingName = $( el ).html();
+		profileHeadings.push( headingName );
+		if (
+			headingsRequired.indexOf( headingName ) === -1 &&
+			headingsOptional.indexOf( headingName ) === -1
+		) {
+			error(
+				'Invalid heading name: "%s".  Expected one of: %s',
+				headingName,
+				JSON.stringify( headingsRequired.concat( headingsOptional ) )
+			);
+		}
+		// Track headings across all profiles
+		if ( ! allProfileHeadings[ headingName ] ) {
+			allProfileHeadings[ headingName ] = [];
+		}
+		allProfileHeadings[ headingName ].push( filename );
+	} );
+
+	headingsRequired.forEach( headingName => {
+		if ( profileHeadings.indexOf( headingName ) === -1 ) {
+			error(
+				'Required heading "%s" not found.',
+				headingName
+			);
+		}
+	} );
 } );
 
+if ( process.env.REPORT_PROFILE_HEADINGS ) {
+	console.log();
+	console.log(
+		'Profile headings by count (%d total profiles):',
+		profileFilenames.length
+	);
+	Object.keys( allProfileHeadings ).forEach( heading => {
+		console.log( '%s: %d', heading, allProfileHeadings[ heading ].length )
+	} );
+}
+
 console.log();
 console.log(
 	'%d problem%s detected',

diff --git a/company-profiles/10up.md b/company-profiles/10up.md
@@ -30,7 +30,7 @@ We have employees all around the world, from across the US to the UK to South Af
 * Nginx
 * Memcache
 
-## Office Locations
+## Office locations
 
 None; or everywhere!
 

diff --git a/company-profiles/17hats.md b/company-profiles/17hats.md
@@ -20,7 +20,7 @@ Worldwide
 
 iOS, React, Knockout, Rails, Perl, HTML, Sql, Ruby, JQuery
 
-## Office Locations
+## Office locations
 
 Not known
 

diff --git a/company-profiles/18f.md b/company-profiles/18f.md
@@ -36,7 +36,7 @@ U.S. citizens, non-citizens who are nationals of the U.S., or people who have be
 
 Ruby, Python, HTML, CSS, JavaScript
 
-## Office Locations
+## Office locations
 
 Federal buildings in San Francisco, Chicago, New York City, and Washington D.C.
 

diff --git a/company-profiles/ably.md b/company-profiles/ably.md
@@ -33,7 +33,7 @@ The bulk of our engineering team is in Europe so we generally prefer candidates
 * We make extensive use of a wide array of AWS services
 * We host our code in Git
 
-## Office Locations
+## Office locations
 
 London, United Kingdom
 

diff --git a/company-profiles/acquia.md b/company-profiles/acquia.md
@@ -26,7 +26,7 @@ Worldwide - Acquia is an international company with office locations around the
 - JavaScript
 - Ruby
 
-## Office Locations
+## Office locations
 
 - Boston, MA, USA (Headquarters)
 - Gent, Belgium

diff --git a/company-profiles/ad-hoc.md b/company-profiles/ad-hoc.md
@@ -24,7 +24,7 @@ USA only for the time being: many of our contracts with the US government requir
 - HTML
 - CSS
 
-## Office Locations
+## Office locations
 
 None! We have a small coworking space for our DC team, but otherwise everyone works remotely.
 

diff --git a/company-profiles/agflow.md b/company-profiles/agflow.md
@@ -22,7 +22,7 @@ Main office is located at Geneva, Switzerland. There is one small office in Wroc
 * Redis
 * React
 
-## Office Locations
+## Office locations
 [Geneva, CH](https://www.google.ch/maps/place/Boulevard+de+Saint-Georges+72,+1205+Genève/)
 
 ## How to apply

diff --git a/company-profiles/agilebits.md b/company-profiles/agilebits.md
@@ -20,7 +20,7 @@ Worldwide. Right now we have folks distributed throughout North America and Euro
 
 \<Unknown\>
 
-## Office Locations
+## Office locations
 
 Toronto, Ontario
 

diff --git a/company-profiles/aha.md b/company-profiles/aha.md
@@ -23,7 +23,7 @@ Worldwide
 
 Ruby on Rails, React, jQuery
 
-## Office Locations
+## Office locations
 
 Worldwide
 

diff --git a/company-profiles/algorithmia.md b/company-profiles/algorithmia.md
@@ -25,7 +25,7 @@ Worldwide, but we work primarily on US timezones.
 - Kubernetes
 - Docker
 
-## Office Locations
+## Office locations
 
 - Seattle, WA
 

diff --git a/company-profiles/allydvm.md b/company-profiles/allydvm.md
@@ -24,7 +24,7 @@ USA
 
 Ruby and RoR, Javascript, AngularJS, Coffeescript, iOS, Android, MySQL, HTML/CSS, Java and Spring
 
-## Office Locations
+## Office locations
 
 \<Unknown\>
 

diff --git a/company-profiles/alphasights.md b/company-profiles/alphasights.md
@@ -29,7 +29,7 @@ Our remote engineers work the same hours as our New York and London offices depe
 * PostgreSQL
 * Git
 
-## Office Locations
+## Office locations
 
 Our engineering offices are located in New York City and London. We have other offices in Dubai, Shanghai, Seoul, and San Francisco.
 

diff --git a/company-profiles/and-yet.md b/company-profiles/and-yet.md
@@ -20,7 +20,7 @@ We employ several strategies that ensure inclusive and collaborative environment
 * Jade
 * Stylus
 
-## Office Locations
+## Office locations
 [Richland, WA](https://www.google.com/maps/place/110+Gage+Blvd,+Richland,+WA+99352)
 
 ## How to apply

diff --git a/company-profiles/anexus.md b/company-profiles/anexus.md
@@ -27,7 +27,7 @@ Latin America - Anexus is a regional company with offices in Costa Rica but a te
 - ReactJS
 - Symfony
 
-## Office Locations
+## Office locations
 
 - San Jose, Costa Rica (Headquarters)
 

diff --git a/company-profiles/apartment-therapy.md b/company-profiles/apartment-therapy.md
@@ -30,7 +30,7 @@ US-based employees only.
 
 CTO Scott Trudeau wrote a gist about their [stack, product team, and mentions working remotely](https://gist.github.com/sstrudeau/f563dc72739e9e047de5)
 
-## Office Locations
+## Office locations
 
 Company office in [NYC - 270 Lafayette St Fl 12 (Prince St.), New York, NY 10012, United States](https://www.google.com/maps/place/Apartment+Therapy/@40.7240504,-73.9965837,20z/data=!4m7!1m4!3m3!1s0x89c27c75f5d73d85:0x4fd9ab773fad77d1!2sProject+Real+Apartment+Treatment,+55+N+Ocean+Ave+%23+2,+Freeport,+NY+11520!3b1!3m1!1s0x0000000000000000:0x9f96cb380f7dbcf7)
 

diff --git a/company-profiles/appstractor.md b/company-profiles/appstractor.md
@@ -22,7 +22,7 @@ Worldwide
 
 LAMP
 
-## Office Locations
+## Office locations
 
 US, UK, Israel offices
 

diff --git a/company-profiles/art-and-logic.md b/company-profiles/art-and-logic.md
@@ -38,7 +38,7 @@ We work with an extensive range of languages and technologies.
 * C#
 * Git
 
-## Office Locations
+## Office locations
 
 Headquarters in Pasadena, CA and offices throughout the US. 
 

diff --git a/company-profiles/artefactual.md b/company-profiles/artefactual.md
@@ -24,7 +24,7 @@ UTC-8 to UTC+2
 
 PHP, Python, JavaScript, git, MySQL, HTML, CSS, Django, Symfony, Ansible, Docker, Jenkins, Nginx, Azure, AWS, Ubuntu, CentOS, RedHat.
 
-## Office Locations
+## Office locations
 
 New Westminster, BC.
 

diff --git a/company-profiles/articulate.md b/company-profiles/articulate.md
@@ -21,7 +21,7 @@ Worldwide
 
 .NET, C#
 
-## Office Locations
+## Office locations
 
 244 5th Avenue, Suite 2960, New York, NY 10001
 

diff --git a/company-profiles/astronomer.md b/company-profiles/astronomer.md
@@ -28,7 +28,7 @@ A good amount of our code is open source on [GitHub](https://github.com/astronom
 
 We publish a variety of technical posts on [our blog](https://www.astronomer.io/blog) and [Medium publication](https://medium.com/the-astronomer-journey/latest).
 
-## Office Locations
+## Office locations
 
 Cincinnati, OH
 

diff --git a/company-profiles/auth0.md b/company-profiles/auth0.md
@@ -35,7 +35,7 @@ Also be familiar with:
 * JSON Web Tokens
 * OAuth, OpenID Connect
 
-## Office Locations
+## Office locations
 
 8 office locations
 

diff --git a/company-profiles/automattic.md b/company-profiles/automattic.md
@@ -26,7 +26,7 @@ Worldwide - our team members hail from all over, every continent except Antarcti
 
 WordPress, [JavaScript (Node/React/Redux)](https://ma.tt/2015/11/dance-to-calypso/), PHP, Spark, Kafka, Elasticsearch, Impala/Hive, MySQL, Java, Python
 
-## Office Locations
+## Office locations
 
 We no longer have an official physical office.
 

diff --git a/company-profiles/axelerant.md b/company-profiles/axelerant.md
@@ -27,7 +27,7 @@ Worldwide - Axelerant team members work from home, cafes, or co-working spaces.
 * JavaScript
 * Ruby
 
-## Office Locations
+## Office locations
 
 * Atlanta, United States
 * Gurgaon, India

diff --git a/company-profiles/balsamiq.md b/company-profiles/balsamiq.md
@@ -20,7 +20,7 @@ We currently have employees in the U.S. and in several European countries.
 
 \<Unknown\>
 
-## Office Locations
+## Office locations
 
 We have one office in Bologna, Italy. All other employees work from home.
 

diff --git a/company-profiles/bandcamp.md b/company-profiles/bandcamp.md
@@ -21,7 +21,7 @@ Worldwide
 
 unknown
 
-## Office Locations
+## Office locations
 
 There is no Bandcamp office. Our team is sprinkled throughout the world.
 

diff --git a/company-profiles/bandzoogle.md b/company-profiles/bandzoogle.md
@@ -23,7 +23,7 @@ Worldwide - Bandzoogle is remote-only.
 
 RoR, Ember.js, APIs
 
-## Office Locations
+## Office locations
 
 No physical location.
 

diff --git a/company-profiles/baremetrics.md b/company-profiles/baremetrics.md
@@ -22,7 +22,7 @@ Worldwide.
 
 PHP, jQuery
 
-## Office Locations
+## Office locations
 
 None, 100% remote.
 

diff --git a/company-profiles/basecamp.md b/company-profiles/basecamp.md
@@ -21,7 +21,7 @@ Worldwide
 
 Ruby, Rails, CoffeeScript, Backbone.js, Memcached, MySQL, S3
 
-## Office Locations
+## Office locations
 
 While people who work at Basecamp can live and work anywhere they want, about 14 of us work out of our Chicago headquarters.
 

diff --git a/company-profiles/big-cartel.md b/company-profiles/big-cartel.md
@@ -20,7 +20,7 @@ Currently we are only set up for US-based remote employees.
 
 Rails, Ember, JSON API, MySQL, Elasticsearch, Redis, Riak, Redshift
 
-## Office Locations
+## Office locations
 
 Salt Lake City, Utah
 

diff --git a/company-profiles/big-wheel-brigade.md b/company-profiles/big-wheel-brigade.md
@@ -22,7 +22,7 @@ US, currently.
 
 Rails, primarily, with some Wordpress clients.
 
-## Office Locations
+## Office locations
 
 Omaha, Nebraska, yo!
 

diff --git a/company-profiles/bitnami.md b/company-profiles/bitnami.md
@@ -27,7 +27,7 @@ We have employees all around the world, with the bulk of our engineering team in
 * We host our code in Git
 * We have a heavy bias towards deploying our services on Kubernetes
 
-## Office Locations
+## Office locations
 
 San Francisco, USA and Seville, Spain.
 

diff --git a/company-profiles/bitovi.md b/company-profiles/bitovi.md
@@ -18,7 +18,7 @@ A team of developers (and designers) located around the US, Canada, and Croatia.
 
 JavaScript, HTML, CSS, etc.
 
-## Office Locations
+## Office locations
 
 Headquarters in Chicago, USA.
 

diff --git a/company-profiles/black-tangent.md b/company-profiles/black-tangent.md
@@ -24,7 +24,7 @@ Worldwide
 
 Ruby on Rails, ReactJS, Elixir, Phoenix
 
-## Office Locations
+## Office locations
 
 There is no official office. Some of us choose to work in co-working space together when they're in the same city.
 

diff --git a/company-profiles/britecore.md b/company-profiles/britecore.md
@@ -29,7 +29,7 @@ Currently our Engineers and Staff work in the US and some are spread across the
 - Jenkins
 - Vue.js, Knockout
 
-## Office Locations
+## Office locations
 
 BriteCore's head office is in Springfield, Missouri.
 

diff --git a/company-profiles/buffer.md b/company-profiles/buffer.md
@@ -24,7 +24,7 @@ Buffer employs people worldwide
 
 Redshift, Hadoop, MongoDB JavaScript, PHP, Underscore, Backbone.
 
-## Office Locations
+## Office locations
 
 No physical office, recently sold HQ and all employees work remotely.
-Original file line number
+Diff line change
@@ Expand Up @@
     - HTML
     - CSS
-    ## Office Locations
+    ## Office locations
     None! We have a small coworking space for our DC team, but otherwise everyone works remotely.
@@ Expand Down @@