Renamed files to kebab-case - core - seeders, importers

ghost/admin/app/controllers/lexical-editor.js

@@ -10,7 +10,7 @@ import UpdateSnippetModal from '../components/editor/modals/update-snippet';
 import boundOneWay from 'ghost-admin/utils/bound-one-way';
 import classic from 'ember-classic-decorator';
 import config from 'ghost-admin/config/environment';
-import isNumber from 'ghost-admin/utils/isNumber';
+import isNumber from 'ghost-admin/utils/is-number';
 import microdiff from 'microdiff';
 import moment from 'moment-timezone';
 import {GENERIC_ERROR_MESSAGE} from '../services/notifications';

ghost/core/.eslintrc.js

@@ -101,8 +101,26 @@ module.exports = {
             }
         },
         {
-            // These folders use kebab-case filenames
-            files: ['core/frontend/**/*.{js,ts}', 'core/server/services/**/*.{js,ts}', 'core/server/*.{js,ts}'],
+            // Enforce kebab-case filenames across core/
+            // Excludes folders for special cases like adapters which need specific file namings
+            files: [
+                'core/**/*.{js,ts}'
+            ],
+            excludedFiles: [
+                // Adapter filenames must match the name specified in config (e.g. adapters.cache.active: "Redis").
+                // The adapter-manager loads adapters by constructing a path from the config value.
+                // See: core/shared/config/defaults.json, core/server/services/adapter-manager
+                'core/server/adapters/**',
+                // Shared events - many external consumers
+                'core/shared/events/**',
+                'core/shared/events-ts/**',
+                // Shared caches
+                'core/shared/custom-theme-settings-cache/**',
+                'core/shared/settings-cache/**',
+                'core/shared/SentryKnexTracingIntegration.js',
+                // libs
+                'core/server/lib/**'
+            ],
             rules: {
                 'ghost/filenames/match-exported-class': 'off',
                 'ghost/filenames/match-regex': ['error', '^[a-z0-9.-]+$', false]

ghost/core/MigratorConfig.js

@@ -1,3 +1,7 @@
+/**
+ * knex-migrator requires this exact filename in the project root, therefore, linter naming rules are disabled here.
+ * @see https://github.com/TryGhost/knex-migrator
+ */
 /* eslint-disable ghost/filenames/match-regex */
 const config = require('./core/shared/config');
 const ghostVersion = require('@tryghost/version');

ghost/core/core/boot.js

@@ -64,7 +64,7 @@ function notifyServerReady(error) {
   * @param {object} options.config
   */
 async function initDatabase({config}) {
-    const DatabaseStateManager = require('./server/data/db/DatabaseStateManager');
+    const DatabaseStateManager = require('./server/data/db/database-state-manager');
     const dbStateManager = new DatabaseStateManager({knexMigratorFilePath: config.get('paths:appRoot')});
     await dbStateManager.makeReady();
 

ghost/core/core/cli/generate-data.js

@@ -1,6 +1,6 @@
 /* eslint-disable ghost/filenames/match-exported-class */
 const Command = require('./command');
-const DataGenerator = require('../server/data/seeders/DataGenerator');
+const DataGenerator = require('../server/data/seeders/data-generator');
 const config = require('../shared/config');
 
 const schemaTables = require('../server/data/schema').tables;

ghost/core/core/server/adapters/cache/Redis.js

@@ -1,3 +1,10 @@
+/**
+ * Filename must match the adapter name specified in config (adapters.cache.active: "Redis").
+ * The adapter-manager loads adapters by constructing a path from the config value.
+ *
+ * @see core/shared/config/defaults.json
+ * @see core/server/services/adapter-manager/adapter-manager.js
+ */
 /* eslint-disable ghost/filenames/match-regex */
 const RedisCache = require('../lib/redis/AdapterCacheRedis');
 

ghost/core/core/server/api/endpoints/utils/validators/input/password_reset.js

@@ -1,3 +1,6 @@
+/**
+ * Filename must match the docName specified in core/server/api/endpoints/authentication.js
+ */
 /* eslint-disable ghost/filenames/match-regex */
 const validator = require('@tryghost/validator');
 const debug = require('@tryghost/debug')('api:endpoints:utils:validators:input:passwordreset');

ghost/core/core/server/data/importer/import-manager.js

@@ -11,11 +11,11 @@ const debug = require('@tryghost/debug')('import-manager');
 const logging = require('@tryghost/logging');
 const errors = require('@tryghost/errors');
 const ImageHandler = require('./handlers/image');
-const ImporterContentFileHandler = require('./handlers/ImporterContentFileHandler');
+const ImporterContentFileHandler = require('./handlers/importer-content-file-handler');
 const RevueHandler = require('./handlers/revue');
 const JSONHandler = require('./handlers/json');
 const MarkdownHandler = require('./handlers/markdown');
-const ContentFileImporter = require('./importers/ContentFileImporter');
+const ContentFileImporter = require('./importers/content-file-importer');
 const RevueImporter = require('./importers/importer-revue');
 const DataImporter = require('./importers/data');
 const urlUtils = require('../../../shared/url-utils');

ghost/core/core/server/data/importer/importers/data/CustomThemeSettingsImporter.js → ghost/core/core/server/data/importer/importers/data/custom-theme-settings-importer.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('importer:roles');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 const {activate} = require('../../../../services/themes/activate');
 const {sequence} = require('@tryghost/promise');

ghost/core/core/server/data/importer/importers/data/data-importer.js

@@ -5,17 +5,17 @@ const {IncorrectUsageError} = require('@tryghost/errors');
 const debug = require('@tryghost/debug')('importer:data');
 const {sequence} = require('@tryghost/promise');
 const models = require('../../../../models');
-const PostsImporter = require('./PostsImporter');
-const TagsImporter = require('./TagsImporter');
-const SettingsImporter = require('./SettingsImporter');
-const UsersImporter = require('./UsersImporter');
-const NewslettersImporter = require('./NewslettersImporter');
-const ProductsImporter = require('./ProductsImporter');
-const StripeProductsImporter = require('./StripeProductsImporter');
-const StripePricesImporter = require('./StripePricesImporter');
-const CustomThemeSettingsImporter = require('./CustomThemeSettingsImporter');
-const RevueSubscriberImporter = require('./RevueSubscriberImporter');
-const RolesImporter = require('./RolesImporter');
+const PostsImporter = require('./posts-importer');
+const TagsImporter = require('./tags-importer');
+const SettingsImporter = require('./settings-importer');
+const UsersImporter = require('./users-importer');
+const NewslettersImporter = require('./newsletters-importer');
+const ProductsImporter = require('./products-importer');
+const StripeProductsImporter = require('./stripe-products-importer');
+const StripePricesImporter = require('./stripe-prices-importer');
+const CustomThemeSettingsImporter = require('./custom-theme-settings-importer');
+const RevueSubscriberImporter = require('./revue-subscriber-importer');
+const RolesImporter = require('./roles-importer');
 const {slugify} = require('@tryghost/string/lib');
 
 let importers = {};

ghost/core/core/server/data/importer/importers/data/NewslettersImporter.js → ghost/core/core/server/data/importer/importers/data/newsletters-importer.js

@@ -1,6 +1,6 @@
 const debug = require('@tryghost/debug')('importer:newsletters');
 const _ = require('lodash');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 
 const ignoredColumns = ['sender_email'];

ghost/core/core/server/data/importer/importers/data/PostsImporter.js → ghost/core/core/server/data/importer/importers/data/posts-importer.js

@@ -1,7 +1,7 @@
 const debug = require('@tryghost/debug')('importer:posts');
 const _ = require('lodash');
 const crypto = require('crypto');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const mobiledocLib = require('../../../../lib/mobiledoc');
 const validator = require('@tryghost/validator');
 const postsMetaSchema = require('../../../schema').tables.posts_meta;

ghost/core/core/server/data/importer/importers/data/ProductsImporter.js → ghost/core/core/server/data/importer/importers/data/products-importer.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 const debug = require('@tryghost/debug')('importer:products');
 

ghost/core/core/server/data/importer/importers/data/RevueSubscriberImporter.js → ghost/core/core/server/data/importer/importers/data/revue-subscriber-importer.js

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('importer:revue-subscriber');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 
 const papaparse = require('papaparse');
 const path = require('path');

ghost/core/core/server/data/importer/importers/data/RolesImporter.js → ghost/core/core/server/data/importer/importers/data/roles-importer.js

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('importer:roles');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 
 class RolesImporter extends BaseImporter {
     constructor(allDataFromFile) {

ghost/core/core/server/data/importer/importers/data/SettingsImporter.js → ghost/core/core/server/data/importer/importers/data/settings-importer.js

@@ -1,7 +1,7 @@
 const debug = require('@tryghost/debug')('importer:settings');
 const ObjectId = require('bson-objectid').default;
 const _ = require('lodash');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 const defaultSettings = require('../../../schema').defaultSettings;
 const keyGroupMapper = require('../../../../api/endpoints/utils/serializers/input/utils/settings-key-group-mapper');

ghost/core/core/server/data/importer/importers/data/StripePricesImporter.js → ghost/core/core/server/data/importer/importers/data/stripe-prices-importer.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('importer:stripeprices');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 
 class StripePricesImporter extends BaseImporter {

ghost/core/core/server/data/importer/importers/data/StripeProductsImporter.js → ghost/core/core/server/data/importer/importers/data/stripe-products-importer.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('importer:stripeproducts');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 
 class StripeProductsImporter extends BaseImporter {

ghost/core/core/server/data/importer/importers/data/TagsImporter.js → ghost/core/core/server/data/importer/importers/data/tags-importer.js

@@ -1,6 +1,6 @@
 const debug = require('@tryghost/debug')('importer:tags');
 const _ = require('lodash');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 const {sequence} = require('@tryghost/promise');
 

ghost/core/core/server/data/importer/importers/data/UsersImporter.js → ghost/core/core/server/data/importer/importers/data/users-importer.js

@@ -1,6 +1,6 @@
 const debug = require('@tryghost/debug')('importer:users');
 const _ = require('lodash');
-const BaseImporter = require('./Base');
+const BaseImporter = require('./base');
 const models = require('../../../../models');
 const limitService = require('../../../../services/limits');
 

ghost/core/core/server/data/migrations/hooks/migrate/afterEach.js → ghost/core/core/server/data/migrations/hooks/migrate/after-each.js

@@ -1,5 +1,3 @@
-/* eslint-disable ghost/filenames/match-regex */
-
 module.exports = function afterEach() {
     return Promise.resolve();
 };

ghost/core/core/server/data/migrations/hooks/migrate/beforeEach.js → ghost/core/core/server/data/migrations/hooks/migrate/before-each.js

@@ -1,5 +1,3 @@
-/* eslint-disable ghost/filenames/match-regex */
-
 module.exports = function beforeEach() {
     return Promise.resolve();
 };

ghost/core/core/server/data/migrations/hooks/migrate/index.js

@@ -1,4 +1,4 @@
 exports.before = require('./before');
-exports.beforeEach = require('./beforeEach');
-exports.afterEach = require('./afterEach');
+exports.beforeEach = require('./before-each');
+exports.afterEach = require('./after-each');
 exports.shutdown = require('./shutdown');

ghost/core/core/server/data/schema/fixtures/index.js

@@ -1,4 +1,4 @@
-const FixtureManager = require('./FixtureManager');
+const FixtureManager = require('./fixture-manager');
 const config = require('../../../../shared/config');
 
 const fixturePath = config.get('paths').fixtures;

ghost/core/core/server/data/seeders/DataGenerator.js → ghost/core/core/server/data/seeders/data-generator.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const fs = require('fs/promises');
-const JsonImporter = require('./utils/JsonImporter');
+const JsonImporter = require('./utils/json-importer');
 const {getProcessRoot} = require('@tryghost/root-utils');
 const topologicalSort = require('./utils/topological-sort');
 const {faker} = require('@faker-js/faker');

ghost/core/core/server/data/seeders/importers/BenefitsImporter.js → ghost/core/core/server/data/seeders/importers/benefits-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {slugify} = require('@tryghost/string');
 const {blogStartDate} = require('../utils/blog-info');

ghost/core/core/server/data/seeders/importers/CommentsImporter.js → ghost/core/core/server/data/seeders/importers/comments-importer.js

@@ -1,5 +1,5 @@
 const {faker} = require('@faker-js/faker');
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {luck} = require('../utils/random');
 const generateEvents = require('../utils/event-generator');
 const dateToDatabaseString = require('../utils/database-date');

ghost/core/core/server/data/seeders/importers/EmailBatchesImporter.js → ghost/core/core/server/data/seeders/importers/email-batches-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const dateToDatabaseString = require('../utils/database-date');
 

ghost/core/core/server/data/seeders/importers/EmailRecipientFailuresImporter.js → ghost/core/core/server/data/seeders/importers/email-recipient-failures-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 
 class EmailRecipientFailuresImporter extends TableImporter {

ghost/core/core/server/data/seeders/importers/EmailRecipientsImporter.js → ghost/core/core/server/data/seeders/importers/email-recipients-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const generateEvents = require('../utils/event-generator');
 const dateToDatabaseString = require('../utils/database-date');

ghost/core/core/server/data/seeders/importers/EmailsImporter.js → ghost/core/core/server/data/seeders/importers/emails-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const generateEvents = require('../utils/event-generator');
 const {luck} = require('../utils/random');

ghost/core/core/server/data/seeders/importers/index.js

@@ -1,41 +1,41 @@
 module.exports = [
-    require('./NewslettersImporter'),
-    require('./PostsImporter'),
-    require('./UsersImporter'),
-    require('./TagsImporter'),
-    require('./ProductsImporter'),
-    require('./MembersImporter'),
-    require('./BenefitsImporter'),
-    require('./WebMentionsImporter'),
-    require('./PostsAuthorsImporter'),
-    require('./PostsTagsImporter'),
-    require('./ProductsBenefitsImporter'),
-    require('./MembersProductsImporter'),
-    require('./PostsProductsImporter'),
-    require('./MembersNewslettersImporter'),
-    require('./StripeProductsImporter'),
-    require('./StripePricesImporter'),
-    require('./EmailsImporter'),
-    require('./EmailBatchesImporter'),
-    require('./EmailRecipientsImporter'),
-    require('./EmailRecipientFailuresImporter'),
-    require('./RedirectsImporter'),
-    require('./MembersClickEventsImporter'),
-    require('./OffersImporter'),
-    require('./MembersCreatedEventsImporter'),
-    require('./MembersLoginEventsImporter'),
-    require('./MembersStatusEventsImporter'),
-    require('./MembersStripeCustomersImporter'),
-    require('./MembersStripeCustomersSubscriptionsImporter'),
-    require('./MembersPaidSubscriptionEventsImporter'),
-    require('./MembersSubscriptionCreatedEventsImporter'),
-    require('./MembersSubscribeEventsImporter'),
-    require('./LabelsImporter'),
-    require('./MembersLabelsImporter'),
-    require('./RolesUsersImporter'),
-    require('./MembersFeedbackImporter'),
-    require('./RecommendationsImporter'),
-    require('./RecommendationClickEventsImporter'),
-    require('./RecommendationSubscribeEventsImporter'),
-    require('./CommentsImporter')
+    require('./newsletters-importer'),
+    require('./posts-importer'),
+    require('./users-importer'),
+    require('./tags-importer'),
+    require('./products-importer'),
+    require('./members-importer'),
+    require('./benefits-importer'),
+    require('./web-mentions-importer'),
+    require('./posts-authors-importer'),
+    require('./posts-tags-importer'),
+    require('./products-benefits-importer'),
+    require('./members-products-importer'),
+    require('./posts-products-importer'),
+    require('./members-newsletters-importer'),
+    require('./stripe-products-importer'),
+    require('./stripe-prices-importer'),
+    require('./emails-importer'),
+    require('./email-batches-importer'),
+    require('./email-recipients-importer'),
+    require('./email-recipient-failures-importer'),
+    require('./redirects-importer'),
+    require('./members-click-events-importer'),
+    require('./offers-importer'),
+    require('./members-created-events-importer'),
+    require('./members-login-events-importer'),
+    require('./members-status-events-importer'),
+    require('./members-stripe-customers-importer'),
+    require('./members-stripe-customers-subscriptions-importer'),
+    require('./members-paid-subscription-events-importer'),
+    require('./members-subscription-created-events-importer'),
+    require('./members-subscribe-events-importer'),
+    require('./labels-importer'),
+    require('./members-labels-importer'),
+    require('./roles-users-importer'),
+    require('./members-feedback-importer'),
+    require('./recommendations-importer'),
+    require('./recommendation-click-events-importer'),
+    require('./recommendation-subscribe-events-importer'),
+    require('./comments-importer')
 ];

ghost/core/core/server/data/seeders/importers/LabelsImporter.js → ghost/core/core/server/data/seeders/importers/labels-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {slugify} = require('@tryghost/string');
 const {blogStartDate} = require('../utils/blog-info');

ghost/core/core/server/data/seeders/importers/MembersClickEventsImporter.js → ghost/core/core/server/data/seeders/importers/members-click-events-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {luck} = require('../utils/random');
 const dateToDatabaseString = require('../utils/database-date');

ghost/core/core/server/data/seeders/importers/MembersCreatedEventsImporter.js → ghost/core/core/server/data/seeders/importers/members-created-events-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {luck} = require('../utils/random');
 const dateToDatabaseString = require('../utils/database-date');

ghost/core/core/server/data/seeders/importers/MembersFeedbackImporter.js → ghost/core/core/server/data/seeders/importers/members-feedback-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {luck} = require('../utils/random');
 const dateToDatabaseString = require('../utils/database-date');

ghost/core/core/server/data/seeders/importers/MembersImporter.js → ghost/core/core/server/data/seeders/importers/members-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {faker: americanFaker} = require('@faker-js/faker/locale/en_US');
 const {blogStartDate: startTime} = require('../utils/blog-info');

ghost/core/core/server/data/seeders/importers/MembersLabelsImporter.js → ghost/core/core/server/data/seeders/importers/members-labels-importer.js

@@ -1,4 +1,4 @@
-const TableImporter = require('./TableImporter');
+const TableImporter = require('./table-importer');
 const {faker} = require('@faker-js/faker');
 const {luck} = require('../utils/random');